Compare commits
64
Commits
e28fa005ed
...
next
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5fe325399b | ||
|
|
24e8b4d027 | ||
|
|
562ce87245 | ||
|
|
1e2f0de877 | ||
|
|
2b1a49e59b | ||
|
|
7968be00e7 | ||
|
|
acb9527944 | ||
|
|
e7ae675155 | ||
|
|
6a7989e08d | ||
|
|
cc18397ee1 | ||
|
|
0662e87f49 | ||
|
|
6387d68786 | ||
|
|
59f1208d8d | ||
|
|
fe734af375 | ||
|
|
967930f9bc | ||
|
|
fe23bb5045 | ||
|
|
83a1585ddc | ||
|
|
ecf47c37f5 | ||
|
|
d444831f41 | ||
|
|
53009cf9a0 | ||
|
|
d8f8748525 | ||
|
|
a7f9bebe6a | ||
|
|
c61cc847d9 | ||
|
|
d3b169a641 | ||
|
|
2331c15aad | ||
|
|
229c89e1f8 | ||
|
|
fcc94ca700 | ||
|
|
e1173eba9e | ||
|
|
76ef8ffaaf | ||
|
|
d31fd529e2 | ||
|
|
129d87d578 | ||
|
|
d539b4c558 | ||
|
|
3cbd7554e2 | ||
|
|
ddfbdc1277 | ||
|
|
3cbdac7bda | ||
|
|
d37c130ee8 | ||
|
|
24b9b58cac | ||
|
|
c267cd215c | ||
|
|
0e6d06a7fc | ||
|
|
e7e408c93e | ||
|
|
3822cdaf1d | ||
|
|
b879644e41 | ||
|
|
bbdf3a70af | ||
|
|
497514d3df | ||
|
|
108e381428 | ||
|
|
292f1eb7a9 | ||
|
|
e3d01454b3 | ||
|
|
e489f3f3d1 | ||
|
|
164fc93a48 | ||
|
|
5100b9a665 | ||
|
|
0b09cf838c | ||
|
|
eceb5f2b2c | ||
|
|
3c725a9ca8 | ||
|
|
1308769a25 | ||
|
|
4ab320ab2d | ||
|
|
5b430cf835 | ||
|
|
1019419b17 | ||
|
|
7c6f0bc01e | ||
|
|
eea90b01e5 | ||
|
|
a054bf828d | ||
|
|
e80c9552eb | ||
|
|
ccb2bf7960 | ||
|
|
0f2e63d0cc | ||
|
|
e3324407ca |
@@ -61,6 +61,10 @@ linters:
|
||||
desc: >-
|
||||
Test-support code belongs in test files and in packages whose
|
||||
directory name ends in test, not in the shipped binary.
|
||||
- pkg: sneak.berlin/go/neoirc/internal/dbtest
|
||||
desc: >-
|
||||
Test-support code belongs in test files and in packages whose
|
||||
directory name ends in test, not in the shipped binary.
|
||||
# Only decisions already recorded in the Go package defaults are
|
||||
# listed here. Every entry matches the module path exactly.
|
||||
gomodguard_v2:
|
||||
|
||||
@@ -47,6 +47,16 @@ func (b *Broker) Notify(userID int64) {
|
||||
}
|
||||
}
|
||||
|
||||
// ListenerCount returns how many channels from Wait are still
|
||||
// registered for the user: those that neither Notify nor Remove
|
||||
// has taken out.
|
||||
func (b *Broker) ListenerCount(userID int64) int {
|
||||
b.mu.Lock()
|
||||
defer b.mu.Unlock()
|
||||
|
||||
return len(b.listeners[userID])
|
||||
}
|
||||
|
||||
// Remove removes a specific wait channel (for cleanup on timeout).
|
||||
func (b *Broker) Remove(
|
||||
userID int64,
|
||||
|
||||
@@ -59,6 +59,39 @@ func TestRemove(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestListenerCount(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
brk := broker.New()
|
||||
|
||||
wantCount := func(step string, userID int64, want int) {
|
||||
t.Helper()
|
||||
|
||||
got := brk.ListenerCount(userID)
|
||||
if got != want {
|
||||
t.Errorf("%s: user %d: got %d, want %d",
|
||||
step, userID, got, want)
|
||||
}
|
||||
}
|
||||
|
||||
wantCount("before Wait", 1, 0)
|
||||
|
||||
waitCh := brk.Wait(1)
|
||||
brk.Wait(1)
|
||||
brk.Wait(2)
|
||||
|
||||
wantCount("after two Waits", 1, 2)
|
||||
|
||||
brk.Remove(1, waitCh)
|
||||
|
||||
wantCount("after Remove", 1, 1)
|
||||
|
||||
brk.Notify(1)
|
||||
|
||||
wantCount("after Notify", 1, 0)
|
||||
wantCount("after Notify", 2, 1)
|
||||
}
|
||||
|
||||
func TestMultipleWaiters(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
|
||||
@@ -25,7 +25,10 @@ const (
|
||||
httpErrThreshold = 400
|
||||
)
|
||||
|
||||
var errHTTP = errors.New("HTTP error")
|
||||
var (
|
||||
errHTTP = errors.New("HTTP error")
|
||||
errJoinRefused = errors.New("the server refused the join")
|
||||
)
|
||||
|
||||
// Client wraps HTTP calls to the neoirc server API.
|
||||
type Client struct {
|
||||
@@ -206,13 +209,35 @@ func (client *Client) PollMessages(
|
||||
}, nil
|
||||
}
|
||||
|
||||
// JoinChannel joins a channel.
|
||||
// JoinChannel joins a channel. It returns an error unless the
|
||||
// server answers that the session joined. When the server
|
||||
// refuses the join, it sends the reason to the message queue as
|
||||
// an error numeric.
|
||||
func (client *Client) JoinChannel(channel string) error {
|
||||
return client.SendMessage(
|
||||
data, err := client.do(
|
||||
http.MethodPost, "/api/v1/messages",
|
||||
&Message{ //nolint:exhaustruct // only command+to needed
|
||||
Command: irc.CmdJoin, To: channel,
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var resp struct {
|
||||
Status string `json:"status"`
|
||||
}
|
||||
|
||||
err = json.Unmarshal(data, &resp)
|
||||
if err != nil {
|
||||
return fmt.Errorf("decode join: %w", err)
|
||||
}
|
||||
|
||||
if resp.Status != "joined" {
|
||||
return errJoinRefused
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// PartChannel leaves a channel.
|
||||
@@ -250,7 +275,7 @@ func (client *Client) ListChannels() (
|
||||
// GetMembers returns members of a channel.
|
||||
func (client *Client) GetMembers(
|
||||
channel string,
|
||||
) ([]string, error) {
|
||||
) ([]Member, error) {
|
||||
name := strings.TrimPrefix(channel, "#")
|
||||
|
||||
data, err := client.do(
|
||||
@@ -263,7 +288,7 @@ func (client *Client) GetMembers(
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var members []string
|
||||
var members []Member
|
||||
|
||||
err = json.Unmarshal(data, &members)
|
||||
if err != nil {
|
||||
|
||||
@@ -2,18 +2,28 @@ package neoircapi_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"reflect"
|
||||
"slices"
|
||||
"strconv"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
api "sneak.berlin/go/neoirc/internal/cli/api"
|
||||
"sneak.berlin/go/neoirc/internal/hashcash"
|
||||
)
|
||||
|
||||
const cookieValue = "opaque-value"
|
||||
const (
|
||||
cookieValue = "opaque-value"
|
||||
testNick = "alice"
|
||||
testChannel = "#general"
|
||||
)
|
||||
|
||||
// newSessionServer starts a plain-HTTP server that, like
|
||||
// neoircd, sets a Secure auth cookie when a session is
|
||||
@@ -24,10 +34,16 @@ func newSessionServer(t *testing.T) *httptest.Server {
|
||||
|
||||
mux := http.NewServeMux()
|
||||
|
||||
// Without hashcash the server sends no hashcash_bits.
|
||||
mux.HandleFunc("GET /api/v1/server", func(
|
||||
writer http.ResponseWriter, _ *http.Request,
|
||||
) {
|
||||
_, _ = io.WriteString(writer, `{}`)
|
||||
_, _ = io.WriteString(writer, `{
|
||||
"name": "My NeoIRC Server",
|
||||
"version": "0.1.0",
|
||||
"motd": "Welcome! Be nice.",
|
||||
"users": 42
|
||||
}`)
|
||||
})
|
||||
|
||||
mux.HandleFunc("POST /api/v1/session", func(
|
||||
@@ -56,9 +72,14 @@ func newSessionServer(t *testing.T) *httptest.Server {
|
||||
return
|
||||
}
|
||||
|
||||
_, _ = io.WriteString(
|
||||
writer, `{"id":1,"nick":"alice","channels":[]}`,
|
||||
)
|
||||
_, _ = io.WriteString(writer, `{
|
||||
"id": 1,
|
||||
"nick": "alice",
|
||||
"channels": [
|
||||
{"id": 1, "name": "#general", "topic": "Welcome!"},
|
||||
{"id": 2, "name": "#dev", "topic": ""}
|
||||
]
|
||||
}`)
|
||||
})
|
||||
|
||||
server := httptest.NewServer(mux)
|
||||
@@ -67,6 +88,344 @@ func newSessionServer(t *testing.T) *httptest.Server {
|
||||
return server
|
||||
}
|
||||
|
||||
// newClientForPath starts a server that answers GET path with
|
||||
// body, and returns a client for it.
|
||||
func newClientForPath(t *testing.T, path, body string) *api.Client {
|
||||
t.Helper()
|
||||
|
||||
mux := http.NewServeMux()
|
||||
|
||||
mux.HandleFunc("GET "+path, func(
|
||||
writer http.ResponseWriter, _ *http.Request,
|
||||
) {
|
||||
_, _ = io.WriteString(writer, body)
|
||||
})
|
||||
|
||||
server := httptest.NewServer(mux)
|
||||
t.Cleanup(server.Close)
|
||||
|
||||
return api.NewClient(server.URL)
|
||||
}
|
||||
|
||||
func TestGetStateDecodesFields(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
client := api.NewClient(newSessionServer(t).URL)
|
||||
|
||||
_, err := client.CreateSession(testNick)
|
||||
if err != nil {
|
||||
t.Fatalf("create session: %v", err)
|
||||
}
|
||||
|
||||
state, err := client.GetState()
|
||||
if err != nil {
|
||||
t.Fatalf("state: %v", err)
|
||||
}
|
||||
|
||||
want := api.StateResponse{
|
||||
ID: 1,
|
||||
Nick: testNick,
|
||||
Channels: []api.Channel{
|
||||
{Name: testChannel, Topic: "Welcome!"},
|
||||
{Name: "#dev", Topic: ""},
|
||||
},
|
||||
}
|
||||
if !reflect.DeepEqual(*state, want) {
|
||||
t.Fatalf("state: got %+v, want %+v", *state, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetServerInfoDecodesFields(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
client := newClientForPath(t, "/api/v1/server", `{
|
||||
"name": "My NeoIRC Server",
|
||||
"version": "0.1.0",
|
||||
"motd": "Welcome! Be nice.",
|
||||
"users": 42,
|
||||
"hashcash_bits": 20
|
||||
}`)
|
||||
|
||||
info, err := client.GetServerInfo()
|
||||
if err != nil {
|
||||
t.Fatalf("server info: %v", err)
|
||||
}
|
||||
|
||||
want := api.ServerInfo{
|
||||
Name: "My NeoIRC Server",
|
||||
MOTD: "Welcome! Be nice.",
|
||||
Version: "0.1.0",
|
||||
HashcashBits: 20,
|
||||
}
|
||||
if *info != want {
|
||||
t.Fatalf("server info: got %+v, want %+v", *info, want)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCreateSessionSendsNickAndStamp serves a server that, like
|
||||
// neoircd with hashcash on, advertises hashcash_bits and creates
|
||||
// the session only for a pow_token the server's validator in
|
||||
// internal/hashcash accepts.
|
||||
func TestCreateSessionSendsNickAndStamp(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const (
|
||||
serverName = "My NeoIRC Server"
|
||||
stampBits = 8
|
||||
sessionID = 7
|
||||
)
|
||||
|
||||
mux := http.NewServeMux()
|
||||
|
||||
mux.HandleFunc("GET /api/v1/server", func(
|
||||
writer http.ResponseWriter, _ *http.Request,
|
||||
) {
|
||||
_, _ = fmt.Fprintf(writer, `{
|
||||
"name": %q,
|
||||
"version": "0.1.0",
|
||||
"motd": "Welcome! Be nice.",
|
||||
"users": 42,
|
||||
"hashcash_bits": %d
|
||||
}`, serverName, stampBits)
|
||||
})
|
||||
|
||||
validator := hashcash.NewValidator(serverName)
|
||||
|
||||
mux.HandleFunc("POST /api/v1/session", func(
|
||||
writer http.ResponseWriter, request *http.Request,
|
||||
) {
|
||||
// Decoded with the field names handleCreateSession uses.
|
||||
var payload struct {
|
||||
Nick string `json:"nick"`
|
||||
Hashcash string `json:"pow_token"` //nolint:tagliatelle
|
||||
}
|
||||
|
||||
err := json.NewDecoder(request.Body).Decode(&payload)
|
||||
if err != nil {
|
||||
writer.WriteHeader(http.StatusBadRequest)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
err = validator.Claim(payload.Hashcash, stampBits)
|
||||
if err != nil {
|
||||
writer.WriteHeader(http.StatusPaymentRequired)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
writer.WriteHeader(http.StatusCreated)
|
||||
|
||||
_ = json.NewEncoder(writer).Encode(map[string]any{
|
||||
"id": sessionID,
|
||||
"nick": payload.Nick,
|
||||
})
|
||||
})
|
||||
|
||||
server := httptest.NewServer(mux)
|
||||
t.Cleanup(server.Close)
|
||||
|
||||
session, err := api.NewClient(server.URL).CreateSession(testNick)
|
||||
if err != nil {
|
||||
t.Fatalf("create session: %v", err)
|
||||
}
|
||||
|
||||
want := api.SessionResponse{ID: sessionID, Nick: testNick}
|
||||
if *session != want {
|
||||
t.Fatalf("session: got %+v, want %+v", *session, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestListChannelsDecodesNamesAndTopics(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
client := newClientForPath(t, "/api/v1/channels", `[
|
||||
{"id": 1, "name": "#general", "topic": "Welcome!"},
|
||||
{"id": 2, "name": "#dev", "topic": "Development discussion"}
|
||||
]`)
|
||||
|
||||
channels, err := client.ListChannels()
|
||||
if err != nil {
|
||||
t.Fatalf("list channels: %v", err)
|
||||
}
|
||||
|
||||
want := []api.Channel{
|
||||
{Name: testChannel, Topic: "Welcome!"},
|
||||
{Name: "#dev", Topic: "Development discussion"},
|
||||
}
|
||||
if !slices.Equal(channels, want) {
|
||||
t.Fatalf("channels: got %+v, want %+v", channels, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetMembersDecodesMemberObjects(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
client := newClientForPath(t, "/api/v1/channels/general/members", `[
|
||||
{
|
||||
"id": 1, "nick": "alice", "username": "alice",
|
||||
"hostname": "host.example.com",
|
||||
"isOperator": true, "isVoiced": false,
|
||||
"lastSeen": "2026-02-10T20:00:00Z"
|
||||
},
|
||||
{
|
||||
"id": 2, "nick": "bob", "username": "bob",
|
||||
"hostname": "host.example.com",
|
||||
"isOperator": false, "isVoiced": true,
|
||||
"lastSeen": "2026-02-10T20:00:00Z"
|
||||
},
|
||||
{
|
||||
"id": 3, "nick": "Carol", "username": "carol",
|
||||
"hostname": "host.example.com",
|
||||
"isOperator": false, "isVoiced": false,
|
||||
"lastSeen": "2026-02-10T20:00:00Z"
|
||||
}
|
||||
]`)
|
||||
|
||||
members, err := client.GetMembers(testChannel)
|
||||
if err != nil {
|
||||
t.Fatalf("get members: %v", err)
|
||||
}
|
||||
|
||||
want := []api.Member{
|
||||
{Nick: testNick, IsOperator: true, IsVoiced: false},
|
||||
{Nick: "bob", IsOperator: false, IsVoiced: true},
|
||||
{Nick: "Carol", IsOperator: false, IsVoiced: false},
|
||||
}
|
||||
if !slices.Equal(members, want) {
|
||||
t.Fatalf("members: got %+v, want %+v", members, want)
|
||||
}
|
||||
}
|
||||
|
||||
// TestPollMessagesAdvancesCursor serves the queue as the server
|
||||
// does: entries after the cursor, and last_id as the new cursor.
|
||||
func TestPollMessagesAdvancesCursor(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const lastQueueID = 42
|
||||
|
||||
mux := http.NewServeMux()
|
||||
|
||||
mux.HandleFunc("GET /api/v1/messages", func(
|
||||
writer http.ResponseWriter, request *http.Request,
|
||||
) {
|
||||
after := request.URL.Query().Get("after")
|
||||
if after == strconv.Itoa(lastQueueID) {
|
||||
_, _ = io.WriteString(
|
||||
writer, `{"messages": [], "last_id": 42}`,
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
_, _ = io.WriteString(writer, `{
|
||||
"messages": [{
|
||||
"id": "b7c8210f-849c-4b90-9ee8-d99c8889358e",
|
||||
"command": "PRIVMSG",
|
||||
"from": "alice",
|
||||
"to": "#general",
|
||||
"body": ["hello world"],
|
||||
"ts": "2026-02-10T20:00:01.234567891Z",
|
||||
"meta": {}
|
||||
}],
|
||||
"last_id": 42
|
||||
}`)
|
||||
})
|
||||
|
||||
server := httptest.NewServer(mux)
|
||||
t.Cleanup(server.Close)
|
||||
|
||||
client := api.NewClient(server.URL)
|
||||
|
||||
first, err := client.PollMessages(0, 0)
|
||||
if err != nil {
|
||||
t.Fatalf("first poll: %v", err)
|
||||
}
|
||||
|
||||
if first.LastID != lastQueueID || len(first.Messages) != 1 {
|
||||
t.Fatalf(
|
||||
"first poll: got last ID %d and %d messages, "+
|
||||
"want %d and 1",
|
||||
first.LastID, len(first.Messages), lastQueueID,
|
||||
)
|
||||
}
|
||||
|
||||
second, err := client.PollMessages(first.LastID, 0)
|
||||
if err != nil {
|
||||
t.Fatalf("second poll: %v", err)
|
||||
}
|
||||
|
||||
if len(second.Messages) != 0 {
|
||||
t.Fatalf(
|
||||
"second poll: got %d messages again, want none",
|
||||
len(second.Messages),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// TestPollMessagesDecodesMessageFields serves a relayed PRIVMSG
|
||||
// with the sender's meta and a numeric, as the server queues
|
||||
// them.
|
||||
func TestPollMessagesDecodesMessageFields(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
client := newClientForPath(t, "/api/v1/messages", `{
|
||||
"messages": [
|
||||
{
|
||||
"id": "b7c8210f-849c-4b90-9ee8-d99c8889358e",
|
||||
"command": "PRIVMSG",
|
||||
"from": "alice",
|
||||
"to": "#general",
|
||||
"body": ["signed message"],
|
||||
"ts": "2026-02-10T20:00:01.234567891Z",
|
||||
"meta": {"sig": "base64...", "alg": "ed25519"}
|
||||
},
|
||||
{
|
||||
"id": "7f5a04f8-eab4-4d2e-be55-f5cfcfaf43c5",
|
||||
"command": "RPL_LUSEROP",
|
||||
"code": 252,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": ["0"],
|
||||
"body": ["operator(s) online"],
|
||||
"ts": "2026-02-10T20:00:02Z",
|
||||
"meta": {}
|
||||
}
|
||||
],
|
||||
"last_id": 42
|
||||
}`)
|
||||
|
||||
result, err := client.PollMessages(0, 0)
|
||||
if err != nil {
|
||||
t.Fatalf("poll: %v", err)
|
||||
}
|
||||
|
||||
want := []api.Message{
|
||||
{
|
||||
ID: "b7c8210f-849c-4b90-9ee8-d99c8889358e",
|
||||
Command: "PRIVMSG",
|
||||
From: testNick,
|
||||
To: testChannel,
|
||||
Body: []any{"signed message"},
|
||||
TS: "2026-02-10T20:00:01.234567891Z",
|
||||
Meta: map[string]any{"sig": "base64...", "alg": "ed25519"},
|
||||
},
|
||||
{
|
||||
ID: "7f5a04f8-eab4-4d2e-be55-f5cfcfaf43c5",
|
||||
Command: "RPL_LUSEROP",
|
||||
From: "neoirc",
|
||||
To: testNick,
|
||||
Params: []string{"0"},
|
||||
Body: []any{"operator(s) online"},
|
||||
TS: "2026-02-10T20:00:02Z",
|
||||
Meta: map[string]any{},
|
||||
},
|
||||
}
|
||||
if !reflect.DeepEqual(result.Messages, want) {
|
||||
t.Fatalf("messages: got %+v, want %+v", result.Messages, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestClientKeepsSessionOverPlainHTTPOnLocalhost(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -85,7 +444,7 @@ func TestClientKeepsSessionOverPlainHTTPOnLocalhost(t *testing.T) {
|
||||
"http://" + net.JoinHostPort(host, serverURL.Port()),
|
||||
)
|
||||
|
||||
_, err := client.CreateSession("alice")
|
||||
_, err := client.CreateSession(testNick)
|
||||
if err != nil {
|
||||
t.Fatalf("create session: %v", err)
|
||||
}
|
||||
@@ -118,7 +477,7 @@ func TestClientWithholdsCookieOverPlainHTTPFromOtherHosts(t *testing.T) {
|
||||
},
|
||||
}
|
||||
|
||||
_, err := client.CreateSession("alice")
|
||||
_, err := client.CreateSession(testNick)
|
||||
if err != nil {
|
||||
t.Fatalf("create session: %v", err)
|
||||
}
|
||||
|
||||
@@ -18,7 +18,7 @@ type SessionResponse struct {
|
||||
type StateResponse struct {
|
||||
ID int64 `json:"id"`
|
||||
Nick string `json:"nick"`
|
||||
Channels []string `json:"channels"`
|
||||
Channels []Channel `json:"channels"`
|
||||
}
|
||||
|
||||
// Message represents a neoirc message envelope.
|
||||
@@ -53,12 +53,19 @@ func (m *Message) BodyLines() []string {
|
||||
}
|
||||
}
|
||||
|
||||
// Channel represents a channel in the list response.
|
||||
// Channel is a channel as GET /api/v1/channels and
|
||||
// GET /api/v1/state describe it.
|
||||
type Channel struct {
|
||||
Name string `json:"name"`
|
||||
Topic string `json:"topic"`
|
||||
Members int `json:"members"`
|
||||
CreatedAt string `json:"createdAt"`
|
||||
}
|
||||
|
||||
// Member is one entry of the response from
|
||||
// GET /api/v1/channels/{name}/members.
|
||||
type Member struct {
|
||||
Nick string `json:"nick"`
|
||||
IsOperator bool `json:"isOperator"`
|
||||
IsVoiced bool `json:"isVoiced"`
|
||||
}
|
||||
|
||||
// ServerInfo is the response from GET /api/v1/server.
|
||||
@@ -72,7 +79,7 @@ type ServerInfo struct {
|
||||
// MessagesResponse wraps polling results.
|
||||
type MessagesResponse struct {
|
||||
Messages []Message `json:"messages"`
|
||||
LastID int64 `json:"lastId"`
|
||||
LastID int64 `json:"last_id"` //nolint:tagliatelle
|
||||
}
|
||||
|
||||
// PollResult wraps the poll response including the cursor.
|
||||
|
||||
+182
-132
@@ -34,13 +34,30 @@ type App struct {
|
||||
|
||||
// Run creates and runs the CLI application.
|
||||
func Run() {
|
||||
err := run(NewUI())
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
// run starts the client on ui and returns when ui stops. Tests
|
||||
// call it with ui on a simulation screen.
|
||||
func run(ui *UI) error {
|
||||
app := &App{ //nolint:exhaustruct
|
||||
ui: NewUI(),
|
||||
ui: ui,
|
||||
nick: "guest",
|
||||
}
|
||||
|
||||
app.ui.OnInput(app.handleInput)
|
||||
app.ui.SetStatus(app.nick, "", "disconnected")
|
||||
|
||||
// SetStatus and AddStatus wait for the event loop, which
|
||||
// app.ui.Run starts below, so they run on a goroutine. The
|
||||
// nick is read first, as a typed /nick may change app.nick.
|
||||
nick := app.nick
|
||||
|
||||
go func() {
|
||||
app.ui.SetStatus(nick, "", "disconnected")
|
||||
|
||||
app.ui.AddStatus(
|
||||
"Welcome to neoirc-cli — an IRC-style client",
|
||||
@@ -50,12 +67,9 @@ func Run() {
|
||||
"[white] to begin, " +
|
||||
"or [yellow]/help[white] for commands",
|
||||
)
|
||||
}()
|
||||
|
||||
err := app.ui.Run()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
return app.ui.Run()
|
||||
}
|
||||
|
||||
func (a *App) handleInput(text string) {
|
||||
@@ -94,22 +108,9 @@ func (a *App) handleInput(text string) {
|
||||
})
|
||||
if err != nil {
|
||||
a.ui.AddStatus(
|
||||
"[red]Send error: " + err.Error(),
|
||||
"[red]Send error: " + escape(err.Error()),
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
timestamp := time.Now().Format(timeFormat)
|
||||
|
||||
a.mu.Lock()
|
||||
nick := a.nick
|
||||
a.mu.Unlock()
|
||||
|
||||
a.ui.AddLine(target, fmt.Sprintf(
|
||||
"[gray]%s [green]<%s>[white] %s",
|
||||
timestamp, nick, text,
|
||||
))
|
||||
}
|
||||
|
||||
func (a *App) handleCommand(text string) {
|
||||
@@ -165,7 +166,7 @@ func (a *App) dispatchInfoCommand(cmd, args string) {
|
||||
a.cmdWhois(args)
|
||||
default:
|
||||
a.ui.AddStatus(
|
||||
"[red]Unknown command: " + cmd,
|
||||
"[red]Unknown command: " + escape(cmd),
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -181,7 +182,7 @@ func (a *App) cmdConnect(serverURL string) {
|
||||
|
||||
serverURL = strings.TrimRight(serverURL, "/")
|
||||
|
||||
a.ui.AddStatus("Connecting to " + serverURL + "...")
|
||||
a.ui.AddStatus("Connecting to " + escape(serverURL) + "...")
|
||||
|
||||
a.mu.Lock()
|
||||
nick := a.nick
|
||||
@@ -191,29 +192,37 @@ func (a *App) cmdConnect(serverURL string) {
|
||||
|
||||
resp, err := client.CreateSession(nick)
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]Connection failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]Connection failed: " + escape(err.Error()),
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// The poll loop of an earlier connection is stopped in the same
|
||||
// step that replaces the client, so it never polls with the new
|
||||
// one.
|
||||
a.mu.Lock()
|
||||
a.client = client
|
||||
a.nick = resp.Nick
|
||||
a.connected = true
|
||||
a.lastQID = 0
|
||||
|
||||
if a.stopPoll != nil {
|
||||
close(a.stopPoll)
|
||||
}
|
||||
|
||||
stop := make(chan struct{})
|
||||
a.stopPoll = stop
|
||||
a.mu.Unlock()
|
||||
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[green]Connected! Nick: %s, Session: %d",
|
||||
resp.Nick, resp.ID,
|
||||
escape(resp.Nick), resp.ID,
|
||||
))
|
||||
a.ui.SetStatus(resp.Nick, "", "connected")
|
||||
|
||||
a.stopPoll = make(chan struct{})
|
||||
|
||||
go a.pollLoop()
|
||||
go a.pollLoop(stop)
|
||||
}
|
||||
|
||||
func (a *App) cmdNick(nick string) {
|
||||
@@ -235,7 +244,7 @@ func (a *App) cmdNick(nick string) {
|
||||
a.mu.Unlock()
|
||||
|
||||
a.ui.AddStatus(
|
||||
"Nick set to " + nick +
|
||||
"Nick set to " + escape(nick) +
|
||||
" (will be used on connect)",
|
||||
)
|
||||
|
||||
@@ -247,9 +256,9 @@ func (a *App) cmdNick(nick string) {
|
||||
Body: []string{nick},
|
||||
})
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]Nick change failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]Nick change failed: " + escape(err.Error()),
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
@@ -260,7 +269,7 @@ func (a *App) cmdNick(nick string) {
|
||||
a.mu.Unlock()
|
||||
|
||||
a.ui.SetStatus(nick, target, "connected")
|
||||
a.ui.AddStatus("Nick changed to " + nick)
|
||||
a.ui.AddStatus("Nick changed to " + escape(nick))
|
||||
}
|
||||
|
||||
func (a *App) cmdJoin(channel string) {
|
||||
@@ -288,9 +297,9 @@ func (a *App) cmdJoin(channel string) {
|
||||
|
||||
err := a.client.JoinChannel(channel)
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]Join failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]Join failed: " + escape(err.Error()),
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
@@ -301,9 +310,6 @@ func (a *App) cmdJoin(channel string) {
|
||||
a.mu.Unlock()
|
||||
|
||||
a.ui.SwitchToBuffer(channel)
|
||||
a.ui.AddLine(channel,
|
||||
"[yellow]*** Joined "+channel,
|
||||
)
|
||||
a.ui.SetStatus(nick, channel, "connected")
|
||||
}
|
||||
|
||||
@@ -331,17 +337,13 @@ func (a *App) cmdPart(channel string) {
|
||||
|
||||
err := a.client.PartChannel(channel)
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]Part failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]Part failed: " + escape(err.Error()),
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
a.ui.AddLine(channel,
|
||||
"[yellow]*** Left "+channel,
|
||||
)
|
||||
|
||||
a.mu.Lock()
|
||||
if a.target == channel {
|
||||
a.target = ""
|
||||
@@ -368,7 +370,6 @@ func (a *App) cmdMsg(args string) {
|
||||
|
||||
a.mu.Lock()
|
||||
connected := a.connected
|
||||
nick := a.nick
|
||||
a.mu.Unlock()
|
||||
|
||||
if !connected {
|
||||
@@ -383,19 +384,10 @@ func (a *App) cmdMsg(args string) {
|
||||
Body: []string{text},
|
||||
})
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]Send failed: %v", err,
|
||||
))
|
||||
|
||||
return
|
||||
a.ui.AddStatus(
|
||||
"[red]Send failed: " + escape(err.Error()),
|
||||
)
|
||||
}
|
||||
|
||||
timestamp := time.Now().Format(timeFormat)
|
||||
|
||||
a.ui.AddLine(target, fmt.Sprintf(
|
||||
"[gray]%s [green]<%s>[white] %s",
|
||||
timestamp, nick, text,
|
||||
))
|
||||
}
|
||||
|
||||
func (a *App) cmdQuery(nick string) {
|
||||
@@ -410,10 +402,16 @@ func (a *App) cmdQuery(nick string) {
|
||||
a.mu.Lock()
|
||||
a.target = nick
|
||||
myNick := a.nick
|
||||
connected := a.connected
|
||||
a.mu.Unlock()
|
||||
|
||||
connStatus := "disconnected"
|
||||
if connected {
|
||||
connStatus = "connected"
|
||||
}
|
||||
|
||||
a.ui.SwitchToBuffer(nick)
|
||||
a.ui.SetStatus(myNick, nick, "connected")
|
||||
a.ui.SetStatus(myNick, nick, connStatus)
|
||||
}
|
||||
|
||||
func (a *App) cmdTopic(args string) {
|
||||
@@ -434,16 +432,9 @@ func (a *App) cmdTopic(args string) {
|
||||
return
|
||||
}
|
||||
|
||||
// The HTTP API has no topic query: a TOPIC needs text.
|
||||
if args == "" {
|
||||
err := a.client.SendMessage(&api.Message{ //nolint:exhaustruct
|
||||
Command: irc.CmdTopic,
|
||||
To: target,
|
||||
})
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]Topic query failed: %v", err,
|
||||
))
|
||||
}
|
||||
a.ui.AddStatus("[red]Usage: /topic <text>")
|
||||
|
||||
return
|
||||
}
|
||||
@@ -454,9 +445,9 @@ func (a *App) cmdTopic(args string) {
|
||||
Body: []string{args},
|
||||
})
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]Topic set failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]Topic set failed: " + escape(err.Error()),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -480,19 +471,39 @@ func (a *App) cmdNames() {
|
||||
|
||||
members, err := a.client.GetMembers(target)
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]Names failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]Names failed: " + escape(err.Error()),
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
nicks := make([]string, 0, len(members))
|
||||
|
||||
for _, member := range members {
|
||||
nicks = append(nicks, memberPrefix(member)+member.Nick)
|
||||
}
|
||||
|
||||
a.ui.AddLine(target, fmt.Sprintf(
|
||||
"[cyan]*** Members of %s: %s",
|
||||
target, strings.Join(members, " "),
|
||||
escape(target), escape(strings.Join(nicks, " ")),
|
||||
))
|
||||
}
|
||||
|
||||
// memberPrefix returns "@" for an operator, "+" for a voiced
|
||||
// member, and "" for anyone else.
|
||||
func memberPrefix(member api.Member) string {
|
||||
if member.IsOperator {
|
||||
return "@"
|
||||
}
|
||||
|
||||
if member.IsVoiced {
|
||||
return "+"
|
||||
}
|
||||
|
||||
return ""
|
||||
}
|
||||
|
||||
func (a *App) cmdList() {
|
||||
a.mu.Lock()
|
||||
connected := a.connected
|
||||
@@ -506,9 +517,9 @@ func (a *App) cmdList() {
|
||||
|
||||
channels, err := a.client.ListChannels()
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]List failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]List failed: " + escape(err.Error()),
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
@@ -517,8 +528,7 @@ func (a *App) cmdList() {
|
||||
|
||||
for _, ch := range channels {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
" %s (%d members) %s",
|
||||
ch.Name, ch.Members, ch.Topic,
|
||||
" %s %s", escape(ch.Name), escape(ch.Topic),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -540,9 +550,9 @@ func (a *App) cmdMotd() {
|
||||
&api.Message{Command: irc.CmdMotd}, //nolint:exhaustruct
|
||||
)
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]MOTD failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]MOTD failed: " + escape(err.Error()),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -578,9 +588,9 @@ func (a *App) cmdWho(args string) {
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]WHO failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]WHO failed: " + escape(err.Error()),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -609,9 +619,9 @@ func (a *App) cmdWhois(args string) {
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]WHOIS failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]WHOIS failed: " + escape(err.Error()),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -628,24 +638,37 @@ func (a *App) cmdWindow(args string) {
|
||||
|
||||
_, _ = fmt.Sscanf(args, "%d", &bufIndex)
|
||||
|
||||
a.ui.SwitchBuffer(bufIndex)
|
||||
|
||||
a.mu.Lock()
|
||||
nick := a.nick
|
||||
connected := a.connected
|
||||
a.mu.Unlock()
|
||||
|
||||
if bufIndex >= 0 && bufIndex < a.ui.BufferCount() {
|
||||
buf := a.ui.buffers[bufIndex]
|
||||
if buf.Name != "(status)" {
|
||||
connStatus := "disconnected"
|
||||
if connected {
|
||||
connStatus = "connected"
|
||||
}
|
||||
|
||||
// Read the name before switching. A message from the server can
|
||||
// add a buffer at any time, but only at the end, so bufIndex
|
||||
// still names this buffer when SwitchBuffer runs.
|
||||
name, found := a.ui.BufferName(bufIndex)
|
||||
if found {
|
||||
a.ui.SwitchBuffer(bufIndex)
|
||||
|
||||
if name != "(status)" {
|
||||
a.mu.Lock()
|
||||
a.target = buf.Name
|
||||
a.target = name
|
||||
a.mu.Unlock()
|
||||
|
||||
a.ui.SetStatus(
|
||||
nick, buf.Name, "connected",
|
||||
nick, name, connStatus,
|
||||
)
|
||||
} else {
|
||||
a.ui.SetStatus(nick, "", "connected")
|
||||
a.mu.Lock()
|
||||
a.target = ""
|
||||
a.mu.Unlock()
|
||||
|
||||
a.ui.SetStatus(nick, "", connStatus)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -676,7 +699,7 @@ func (a *App) cmdHelp() {
|
||||
" /part [#chan] — Leave channel",
|
||||
" /msg <nick> <text> — Send DM",
|
||||
" /query <nick> — Open DM window",
|
||||
" /topic [text] — View/set topic",
|
||||
" /topic <text> — Set topic",
|
||||
" /names — List channel members",
|
||||
" /list — List channels",
|
||||
" /who [#channel] — List users in channel",
|
||||
@@ -693,16 +716,23 @@ func (a *App) cmdHelp() {
|
||||
}
|
||||
}
|
||||
|
||||
// pollLoop long-polls for messages in the background.
|
||||
func (a *App) pollLoop() {
|
||||
// pollLoop long-polls for messages in the background until stop is
|
||||
// closed. A later /connect closes stop under a.mu as it replaces the
|
||||
// client and the cursor, so the loop checks stop under a.mu too. A
|
||||
// stopped loop then neither polls with the new client nor moves the
|
||||
// new cursor.
|
||||
func (a *App) pollLoop(stop <-chan struct{}) {
|
||||
for {
|
||||
a.mu.Lock()
|
||||
|
||||
select {
|
||||
case <-a.stopPoll:
|
||||
case <-stop:
|
||||
a.mu.Unlock()
|
||||
|
||||
return
|
||||
default:
|
||||
}
|
||||
|
||||
a.mu.Lock()
|
||||
client := a.client
|
||||
lastQID := a.lastQID
|
||||
a.mu.Unlock()
|
||||
@@ -720,12 +750,24 @@ func (a *App) pollLoop() {
|
||||
continue
|
||||
}
|
||||
|
||||
if result.LastID > 0 {
|
||||
// A poll sent before stop was closed answers for the earlier
|
||||
// connection.
|
||||
a.mu.Lock()
|
||||
a.lastQID = result.LastID
|
||||
|
||||
select {
|
||||
case <-stop:
|
||||
a.mu.Unlock()
|
||||
|
||||
return
|
||||
default:
|
||||
}
|
||||
|
||||
if result.LastID > 0 {
|
||||
a.lastQID = result.LastID
|
||||
}
|
||||
|
||||
a.mu.Unlock()
|
||||
|
||||
for i := range result.Messages {
|
||||
a.handleServerMessage(&result.Messages[i])
|
||||
}
|
||||
@@ -745,7 +787,7 @@ func (a *App) handleServerMessage(msg *api.Message) {
|
||||
case irc.CmdJoin:
|
||||
a.handleJoinEvent(msg, timestamp)
|
||||
case irc.CmdPart:
|
||||
a.handlePartEvent(msg, timestamp)
|
||||
a.handlePartEvent(msg, timestamp, myNick)
|
||||
case irc.CmdQuit:
|
||||
a.handleQuitEvent(msg, timestamp)
|
||||
case irc.CmdNick:
|
||||
@@ -773,18 +815,16 @@ func (a *App) handlePrivmsgEvent(
|
||||
lines := msg.BodyLines()
|
||||
text := strings.Join(lines, " ")
|
||||
|
||||
if msg.From == myNick {
|
||||
return
|
||||
}
|
||||
|
||||
// A direct message shows in the buffer of the other user:
|
||||
// the recipient of one the user sent, else the sender.
|
||||
target := msg.To
|
||||
if !strings.HasPrefix(target, "#") {
|
||||
if !strings.HasPrefix(target, "#") && msg.From != myNick {
|
||||
target = msg.From
|
||||
}
|
||||
|
||||
a.ui.AddLine(target, fmt.Sprintf(
|
||||
"[gray]%s [green]<%s>[white] %s",
|
||||
timestamp, msg.From, text,
|
||||
timestamp, escape(msg.From), escape(text),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -797,12 +837,15 @@ func (a *App) handleJoinEvent(
|
||||
|
||||
a.ui.AddLine(msg.To, fmt.Sprintf(
|
||||
"[gray]%s [yellow]*** %s has joined %s",
|
||||
timestamp, msg.From, msg.To,
|
||||
timestamp, escape(msg.From), escape(msg.To),
|
||||
))
|
||||
}
|
||||
|
||||
// handlePartEvent shows a part in the channel's buffer. The
|
||||
// user's own part does not mark the channel unread: the user
|
||||
// has just left it.
|
||||
func (a *App) handlePartEvent(
|
||||
msg *api.Message, timestamp string,
|
||||
msg *api.Message, timestamp, myNick string,
|
||||
) {
|
||||
if msg.To == "" {
|
||||
return
|
||||
@@ -811,17 +854,22 @@ func (a *App) handlePartEvent(
|
||||
lines := msg.BodyLines()
|
||||
reason := strings.Join(lines, " ")
|
||||
|
||||
if reason != "" {
|
||||
a.ui.AddLine(msg.To, fmt.Sprintf(
|
||||
"[gray]%s [yellow]*** %s has left %s (%s)",
|
||||
timestamp, msg.From, msg.To, reason,
|
||||
))
|
||||
} else {
|
||||
a.ui.AddLine(msg.To, fmt.Sprintf(
|
||||
line := fmt.Sprintf(
|
||||
"[gray]%s [yellow]*** %s has left %s",
|
||||
timestamp, msg.From, msg.To,
|
||||
))
|
||||
timestamp, escape(msg.From), escape(msg.To),
|
||||
)
|
||||
|
||||
if reason != "" {
|
||||
line += " (" + escape(reason) + ")"
|
||||
}
|
||||
|
||||
if msg.From == myNick {
|
||||
a.ui.AddLineAsRead(msg.To, line)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
a.ui.AddLine(msg.To, line)
|
||||
}
|
||||
|
||||
func (a *App) handleQuitEvent(
|
||||
@@ -833,12 +881,12 @@ func (a *App) handleQuitEvent(
|
||||
if reason != "" {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[gray]%s [yellow]*** %s has quit (%s)",
|
||||
timestamp, msg.From, reason,
|
||||
timestamp, escape(msg.From), escape(reason),
|
||||
))
|
||||
} else {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[gray]%s [yellow]*** %s has quit",
|
||||
timestamp, msg.From,
|
||||
timestamp, escape(msg.From),
|
||||
))
|
||||
}
|
||||
}
|
||||
@@ -865,7 +913,7 @@ func (a *App) handleNickEvent(
|
||||
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[gray]%s [yellow]*** %s is now known as %s",
|
||||
timestamp, msg.From, newNick,
|
||||
timestamp, escape(msg.From), escape(newNick),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -877,7 +925,7 @@ func (a *App) handleNoticeEvent(
|
||||
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[gray]%s [magenta]--%s-- %s",
|
||||
timestamp, msg.From, text,
|
||||
timestamp, escape(msg.From), escape(text),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -893,7 +941,7 @@ func (a *App) handleTopicEvent(
|
||||
|
||||
a.ui.AddLine(msg.To, fmt.Sprintf(
|
||||
"[gray]%s [cyan]*** %s set topic: %s",
|
||||
timestamp, msg.From, text,
|
||||
timestamp, escape(msg.From), escape(text),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -903,10 +951,12 @@ func (a *App) handleDefaultEvent(
|
||||
lines := msg.BodyLines()
|
||||
text := strings.Join(lines, " ")
|
||||
|
||||
// The brackets around the command are escaped with it, as tview
|
||||
// reads a command such as "[MODE]" as a tag.
|
||||
if text != "" {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[gray]%s [white][%s] %s",
|
||||
timestamp, msg.Command, text,
|
||||
"[gray]%s [white]%s %s",
|
||||
timestamp, escape("["+msg.Command+"]"), escape(text),
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
+96
-14
@@ -16,7 +16,10 @@ type Buffer struct {
|
||||
Unread int
|
||||
}
|
||||
|
||||
// UI manages the terminal interface.
|
||||
// UI manages the terminal interface. Most of its methods wait for
|
||||
// the tview event loop to run their update. Code that runs on that
|
||||
// loop, such as a key handler, must not call them: it would wait
|
||||
// for itself.
|
||||
type UI struct {
|
||||
app *tview.Application
|
||||
messages *tview.TextView
|
||||
@@ -27,7 +30,17 @@ type UI struct {
|
||||
buffers []*Buffer
|
||||
currentBuffer int
|
||||
|
||||
// The nick, target and connection state last passed to
|
||||
// SetStatus.
|
||||
nick string
|
||||
target string
|
||||
connStatus string
|
||||
|
||||
onInput func(string)
|
||||
// inputDone is closed once the line last passed to onInput
|
||||
// has been handled. Only callOnInput, on the event loop, uses
|
||||
// it.
|
||||
inputDone chan struct{}
|
||||
}
|
||||
|
||||
// NewUI creates the tview-based IRC-like UI.
|
||||
@@ -95,6 +108,19 @@ func (ui *UI) AddLine(bufferName, line string) {
|
||||
})
|
||||
}
|
||||
|
||||
// AddLineAsRead adds a line to the specified buffer, as
|
||||
// AddLine does, but does not mark the buffer unread.
|
||||
func (ui *UI) AddLineAsRead(bufferName, line string) {
|
||||
ui.app.QueueUpdateDraw(func() {
|
||||
buf := ui.getOrCreateBuffer(bufferName)
|
||||
buf.Lines = append(buf.Lines, line)
|
||||
|
||||
if ui.buffers[ui.currentBuffer] == buf {
|
||||
_, _ = fmt.Fprintln(ui.messages, line)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// AddStatus adds a line to the status buffer.
|
||||
func (ui *UI) AddStatus(line string) {
|
||||
ts := time.Now().Format("15:04")
|
||||
@@ -159,13 +185,32 @@ func (ui *UI) SetStatus(
|
||||
nick, target, connStatus string,
|
||||
) {
|
||||
ui.app.QueueUpdateDraw(func() {
|
||||
ui.renderStatusBar(nick, target, connStatus)
|
||||
ui.nick = nick
|
||||
ui.target = target
|
||||
ui.connStatus = connStatus
|
||||
|
||||
ui.refreshStatusBar()
|
||||
})
|
||||
}
|
||||
|
||||
// BufferCount returns the number of buffers.
|
||||
func (ui *UI) BufferCount() int {
|
||||
return len(ui.buffers)
|
||||
// BufferName returns the name of the buffer at index bufIndex,
|
||||
// and whether there is such a buffer.
|
||||
func (ui *UI) BufferName(bufIndex int) (string, bool) {
|
||||
var (
|
||||
name string
|
||||
found bool
|
||||
)
|
||||
|
||||
ui.app.QueueUpdate(func() {
|
||||
if bufIndex < 0 || bufIndex >= len(ui.buffers) {
|
||||
return
|
||||
}
|
||||
|
||||
name = ui.buffers[bufIndex].Name
|
||||
found = true
|
||||
})
|
||||
|
||||
return name, found
|
||||
}
|
||||
|
||||
// BufferIndex returns the index of a named buffer.
|
||||
@@ -190,9 +235,21 @@ func (ui *UI) initMessages() {
|
||||
ui.messages.SetBorder(false)
|
||||
}
|
||||
|
||||
// escape returns text so that the message window shows it exactly
|
||||
// as written. It writes each "[" as "[[:]": a "[" followed by
|
||||
// another "[" never starts a tag, and the tag "[:]" changes
|
||||
// nothing. tview.Escape is not enough: it does not escape a bracket
|
||||
// pair holding a symbol such as "|" or "^", and nothing it adds
|
||||
// stops a tag with a URL, such as "[:::y|z]".
|
||||
func escape(text string) string {
|
||||
return strings.ReplaceAll(text, "[", "[[:]")
|
||||
}
|
||||
|
||||
func (ui *UI) initStatusBar() {
|
||||
ui.statusBar = tview.NewTextView().
|
||||
SetDynamicColors(true)
|
||||
// Colour tags stay off. With them on, tview reads text in
|
||||
// square brackets, such as "[connected]" or part of a nick,
|
||||
// as a tag and drops it.
|
||||
ui.statusBar = tview.NewTextView()
|
||||
ui.statusBar.SetBackgroundColor(tcell.ColorNavy)
|
||||
ui.statusBar.SetTextColor(tcell.ColorWhite)
|
||||
}
|
||||
@@ -213,10 +270,7 @@ func (ui *UI) initInput() {
|
||||
}
|
||||
|
||||
ui.input.SetText("")
|
||||
|
||||
if ui.onInput != nil {
|
||||
ui.onInput(text)
|
||||
}
|
||||
ui.callOnInput(text)
|
||||
})
|
||||
}
|
||||
|
||||
@@ -227,10 +281,11 @@ func (ui *UI) initKeyCapture() {
|
||||
return event
|
||||
}
|
||||
|
||||
// Alt and a digit runs /window with that digit.
|
||||
// SwitchBuffer alone would leave the target as it was.
|
||||
r := event.Rune()
|
||||
if r >= '0' && r <= '9' {
|
||||
idx := int(r - '0')
|
||||
ui.SwitchBuffer(idx)
|
||||
ui.callOnInput("/window " + string(r))
|
||||
|
||||
return nil
|
||||
}
|
||||
@@ -240,8 +295,35 @@ func (ui *UI) initKeyCapture() {
|
||||
)
|
||||
}
|
||||
|
||||
// callOnInput passes text to the input callback on a new
|
||||
// goroutine. The key handlers call it on the event loop, and the
|
||||
// callback waits for that loop to update the screen, so they must
|
||||
// not wait for the callback. The goroutine first waits for the
|
||||
// line before it to be handled, which keeps lines in the order
|
||||
// they were typed.
|
||||
func (ui *UI) callOnInput(text string) {
|
||||
if ui.onInput == nil {
|
||||
return
|
||||
}
|
||||
|
||||
previous := ui.inputDone
|
||||
done := make(chan struct{})
|
||||
ui.inputDone = done
|
||||
|
||||
go func() {
|
||||
if previous != nil {
|
||||
<-previous
|
||||
}
|
||||
|
||||
ui.onInput(text)
|
||||
close(done)
|
||||
}()
|
||||
}
|
||||
|
||||
// refreshStatusBar redraws the status bar with the nick, target
|
||||
// and connection state last passed to SetStatus.
|
||||
func (ui *UI) refreshStatusBar() {
|
||||
// Placeholder; full refresh needs nick/target context.
|
||||
ui.renderStatusBar(ui.nick, ui.target, ui.connStatus)
|
||||
}
|
||||
|
||||
func (ui *UI) renderStatusBar(
|
||||
|
||||
+118
-8
@@ -3,7 +3,12 @@ package config
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"math"
|
||||
"os"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
"github.com/spf13/viper"
|
||||
"go.uber.org/fx"
|
||||
@@ -21,6 +26,14 @@ const defaultMOTD = ` _ __ ___ ___ (_)_ __ ___
|
||||
Welcome to NeoIRC — IRC semantics over HTTP.
|
||||
Type /help for available commands.`
|
||||
|
||||
// DefaultDBURL is the database URL used when DBURL is not set. Its
|
||||
// _pragma parameters, which the SQLite driver runs on every connection
|
||||
// it opens, set WAL mode and a 5000 ms busy timeout.
|
||||
const DefaultDBURL = "file:///var/lib/neoirc/state.db" +
|
||||
"?_pragma=journal_mode(WAL)&_pragma=busy_timeout(5000)"
|
||||
|
||||
var errOutOfRange = errors.New("setting out of range")
|
||||
|
||||
// Params defines the dependencies for creating a Config.
|
||||
type Params struct {
|
||||
fx.In
|
||||
@@ -56,6 +69,8 @@ type Config struct {
|
||||
}
|
||||
|
||||
// New creates a new Config by reading from files and environment variables.
|
||||
// It returns an error when a number, true/false or duration setting does
|
||||
// not parse or is out of range.
|
||||
func New(
|
||||
_ fx.Lifecycle, params Params,
|
||||
) (*Config, error) {
|
||||
@@ -71,7 +86,7 @@ func New(
|
||||
viper.SetDefault("DEBUG", "false")
|
||||
viper.SetDefault("MAINTENANCE_MODE", "false")
|
||||
viper.SetDefault("PORT", "8080")
|
||||
viper.SetDefault("DBURL", "file:///var/lib/neoirc/state.db?_journal_mode=WAL")
|
||||
viper.SetDefault("DBURL", DefaultDBURL)
|
||||
viper.SetDefault("SENTRY_DSN", "")
|
||||
viper.SetDefault("METRICS_USERNAME", "")
|
||||
viper.SetDefault("METRICS_PASSWORD", "")
|
||||
@@ -100,29 +115,34 @@ func New(
|
||||
|
||||
cfg := &Config{
|
||||
DBURL: viper.GetString("DBURL"),
|
||||
Debug: viper.GetBool("DEBUG"),
|
||||
Port: viper.GetInt("PORT"),
|
||||
SentryDSN: viper.GetString("SENTRY_DSN"),
|
||||
MaintenanceMode: viper.GetBool("MAINTENANCE_MODE"),
|
||||
MetricsUsername: viper.GetString("METRICS_USERNAME"),
|
||||
MetricsPassword: viper.GetString("METRICS_PASSWORD"),
|
||||
MessageMaxAge: viper.GetString("MESSAGE_MAX_AGE"),
|
||||
MaxMessageSize: viper.GetInt("MAX_MESSAGE_SIZE"),
|
||||
QueueMaxAge: viper.GetString("QUEUE_MAX_AGE"),
|
||||
MOTD: viper.GetString("MOTD"),
|
||||
ServerName: viper.GetString("SERVER_NAME"),
|
||||
FederationKey: viper.GetString("FEDERATION_KEY"),
|
||||
SessionIdleTimeout: viper.GetString("SESSION_IDLE_TIMEOUT"),
|
||||
HashcashBits: viper.GetInt("NEOIRC_HASHCASH_BITS"),
|
||||
OperName: viper.GetString("NEOIRC_OPER_NAME"),
|
||||
OperPassword: viper.GetString("NEOIRC_OPER_PASSWORD"),
|
||||
LoginRateLimit: viper.GetFloat64("LOGIN_RATE_LIMIT"),
|
||||
LoginRateBurst: viper.GetInt("LOGIN_RATE_BURST"),
|
||||
IRCListenAddr: viper.GetString("IRC_LISTEN_ADDR"),
|
||||
log: log,
|
||||
params: ¶ms,
|
||||
}
|
||||
|
||||
err = parseSettings(cfg)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Viper counts an empty environment variable as unset, but an
|
||||
// empty IRC_LISTEN_ADDR must turn the IRC listener off.
|
||||
ircListenAddr, set := os.LookupEnv("IRC_LISTEN_ADDR")
|
||||
if set {
|
||||
cfg.IRCListenAddr = ircListenAddr
|
||||
}
|
||||
|
||||
if cfg.Debug {
|
||||
params.Logger.EnableDebugLogging()
|
||||
cfg.log = params.Logger.Get()
|
||||
@@ -130,3 +150,93 @@ func New(
|
||||
|
||||
return cfg, nil
|
||||
}
|
||||
|
||||
// parseSettings reads the number and true/false settings into cfg and
|
||||
// checks the duration settings. Each number and duration must be above
|
||||
// zero. PORT and NEOIRC_HASHCASH_BITS may also be zero: port 0 lets the
|
||||
// system pick a port, and 0 bits turns proof of work off. The error
|
||||
// names each setting that does not parse or is out of range.
|
||||
func parseSettings(cfg *Config) error {
|
||||
return errors.Join(
|
||||
parseInt("PORT", 0, &cfg.Port),
|
||||
parseInt("MAX_MESSAGE_SIZE", 1, &cfg.MaxMessageSize),
|
||||
parseInt("NEOIRC_HASHCASH_BITS", 0, &cfg.HashcashBits),
|
||||
parseInt("LOGIN_RATE_BURST", 1, &cfg.LoginRateBurst),
|
||||
parseFloat("LOGIN_RATE_LIMIT", &cfg.LoginRateLimit),
|
||||
parseBool("DEBUG", &cfg.Debug),
|
||||
parseBool("MAINTENANCE_MODE", &cfg.MaintenanceMode),
|
||||
checkDuration("MESSAGE_MAX_AGE", cfg.MessageMaxAge),
|
||||
checkDuration("QUEUE_MAX_AGE", cfg.QueueMaxAge),
|
||||
checkDuration("SESSION_IDLE_TIMEOUT", cfg.SessionIdleTimeout),
|
||||
)
|
||||
}
|
||||
|
||||
// parseInt sets *value to the setting key read as a whole number. It
|
||||
// returns an error when the value does not parse or is below minimum.
|
||||
func parseInt(key string, minimum int, value *int) error {
|
||||
raw := viper.GetString(key)
|
||||
|
||||
parsed, err := strconv.Atoi(raw)
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot parse %s: %w", key, err)
|
||||
}
|
||||
|
||||
if parsed < minimum {
|
||||
return fmt.Errorf("%w: %s is %s, but must be at least %d",
|
||||
errOutOfRange, key, raw, minimum)
|
||||
}
|
||||
|
||||
*value = parsed
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// parseFloat sets *value to the setting key read as a floating-point
|
||||
// number. It returns an error when the value does not parse or is not a
|
||||
// finite number above zero.
|
||||
func parseFloat(key string, value *float64) error {
|
||||
raw := viper.GetString(key)
|
||||
|
||||
parsed, err := strconv.ParseFloat(raw, 64)
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot parse %s: %w", key, err)
|
||||
}
|
||||
|
||||
if math.IsNaN(parsed) || math.IsInf(parsed, 0) || parsed <= 0 {
|
||||
return fmt.Errorf(
|
||||
"%w: %s is %s, but must be a finite number above zero",
|
||||
errOutOfRange, key, raw)
|
||||
}
|
||||
|
||||
*value = parsed
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// parseBool sets *value to the setting key read as true or false.
|
||||
func parseBool(key string, value *bool) error {
|
||||
parsed, err := strconv.ParseBool(viper.GetString(key))
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot parse %s: %w", key, err)
|
||||
}
|
||||
|
||||
*value = parsed
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// checkDuration returns an error naming the setting key when value is
|
||||
// not a Go duration above zero.
|
||||
func checkDuration(key, value string) error {
|
||||
duration, err := time.ParseDuration(value)
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot parse %s: %w", key, err)
|
||||
}
|
||||
|
||||
if duration <= 0 {
|
||||
return fmt.Errorf("%w: %s is %s, but must be above zero",
|
||||
errOutOfRange, key, value)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -0,0 +1,208 @@
|
||||
package config_test
|
||||
|
||||
import (
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/config"
|
||||
"sneak.berlin/go/neoirc/internal/globals"
|
||||
"sneak.berlin/go/neoirc/internal/logger"
|
||||
)
|
||||
|
||||
// loadConfig runs config.New and returns its result.
|
||||
func loadConfig(t *testing.T) (*config.Config, error) {
|
||||
t.Helper()
|
||||
|
||||
globs := &globals.Globals{
|
||||
Appname: "neoirc-test",
|
||||
Version: "test",
|
||||
StartTime: time.Now(),
|
||||
}
|
||||
|
||||
log, err := logger.New(nil, logger.Params{Globals: globs})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
return config.New(
|
||||
nil, config.Params{Globals: globs, Logger: log},
|
||||
)
|
||||
}
|
||||
|
||||
func newConfig(t *testing.T) *config.Config {
|
||||
t.Helper()
|
||||
|
||||
cfg, err := loadConfig(t)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
return cfg
|
||||
}
|
||||
|
||||
func TestUnsetSettingsKeepDefaults(t *testing.T) {
|
||||
// Viper counts an empty environment variable as unset.
|
||||
t.Setenv("PORT", "")
|
||||
t.Setenv("MAX_MESSAGE_SIZE", "")
|
||||
t.Setenv("NEOIRC_HASHCASH_BITS", "")
|
||||
t.Setenv("LOGIN_RATE_BURST", "")
|
||||
t.Setenv("LOGIN_RATE_LIMIT", "")
|
||||
t.Setenv("DEBUG", "")
|
||||
t.Setenv("MAINTENANCE_MODE", "")
|
||||
t.Setenv("MESSAGE_MAX_AGE", "")
|
||||
t.Setenv("QUEUE_MAX_AGE", "")
|
||||
t.Setenv("SESSION_IDLE_TIMEOUT", "")
|
||||
|
||||
// Each duration setting defaults to 30 days.
|
||||
const thirtyDays = "720h"
|
||||
|
||||
want := settings{
|
||||
Port: 8080,
|
||||
MaxMessageSize: 4096,
|
||||
HashcashBits: 20,
|
||||
LoginRateBurst: 5,
|
||||
LoginRateLimit: 1,
|
||||
Debug: false,
|
||||
MaintenanceMode: false,
|
||||
MessageMaxAge: thirtyDays,
|
||||
QueueMaxAge: thirtyDays,
|
||||
SessionIdleTimeout: thirtyDays,
|
||||
}
|
||||
|
||||
got := settingsOf(newConfig(t))
|
||||
if got != want {
|
||||
t.Errorf("settings = %+v, want %+v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidSettingsAreUsed(t *testing.T) {
|
||||
// Each whole number is the lowest value its setting allows, and 1ns
|
||||
// is the shortest duration allowed.
|
||||
t.Setenv("PORT", "0")
|
||||
t.Setenv("MAX_MESSAGE_SIZE", "1")
|
||||
t.Setenv("NEOIRC_HASHCASH_BITS", "0")
|
||||
t.Setenv("LOGIN_RATE_BURST", "1")
|
||||
t.Setenv("LOGIN_RATE_LIMIT", "0.5")
|
||||
t.Setenv("DEBUG", "true")
|
||||
t.Setenv("MAINTENANCE_MODE", "true")
|
||||
t.Setenv("MESSAGE_MAX_AGE", "1ns")
|
||||
t.Setenv("QUEUE_MAX_AGE", "1h30m")
|
||||
t.Setenv("SESSION_IDLE_TIMEOUT", "45m")
|
||||
|
||||
want := settings{
|
||||
Port: 0,
|
||||
MaxMessageSize: 1,
|
||||
HashcashBits: 0,
|
||||
LoginRateBurst: 1,
|
||||
LoginRateLimit: 0.5,
|
||||
Debug: true,
|
||||
MaintenanceMode: true,
|
||||
MessageMaxAge: "1ns",
|
||||
QueueMaxAge: "1h30m",
|
||||
SessionIdleTimeout: "45m",
|
||||
}
|
||||
|
||||
got := settingsOf(newConfig(t))
|
||||
if got != want {
|
||||
t.Errorf("settings = %+v, want %+v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// settings holds the Config fields whose settings config.New parses.
|
||||
type settings struct {
|
||||
Port int
|
||||
MaxMessageSize int
|
||||
HashcashBits int
|
||||
LoginRateBurst int
|
||||
LoginRateLimit float64
|
||||
Debug bool
|
||||
MaintenanceMode bool
|
||||
MessageMaxAge string
|
||||
QueueMaxAge string
|
||||
SessionIdleTimeout string
|
||||
}
|
||||
|
||||
func settingsOf(cfg *config.Config) settings {
|
||||
return settings{
|
||||
Port: cfg.Port,
|
||||
MaxMessageSize: cfg.MaxMessageSize,
|
||||
HashcashBits: cfg.HashcashBits,
|
||||
LoginRateBurst: cfg.LoginRateBurst,
|
||||
LoginRateLimit: cfg.LoginRateLimit,
|
||||
Debug: cfg.Debug,
|
||||
MaintenanceMode: cfg.MaintenanceMode,
|
||||
MessageMaxAge: cfg.MessageMaxAge,
|
||||
QueueMaxAge: cfg.QueueMaxAge,
|
||||
SessionIdleTimeout: cfg.SessionIdleTimeout,
|
||||
}
|
||||
}
|
||||
|
||||
func TestBadSettingStopsStartup(t *testing.T) {
|
||||
// For each setting, the first value does not parse and the others
|
||||
// parse but are out of range.
|
||||
tests := []struct {
|
||||
key string
|
||||
values []string
|
||||
}{
|
||||
{key: "PORT", values: []string{"80a", "-1"}},
|
||||
{key: "MAX_MESSAGE_SIZE", values: []string{"4k", "0", "-4096"}},
|
||||
{key: "NEOIRC_HASHCASH_BITS", values: []string{"twenty", "-1"}},
|
||||
{key: "LOGIN_RATE_BURST", values: []string{"five", "0", "-5"}},
|
||||
{key: "LOGIN_RATE_LIMIT", values: []string{
|
||||
"fast", "0", "-1", "NaN", "Inf", "-Inf",
|
||||
}},
|
||||
{key: "DEBUG", values: []string{"yes"}},
|
||||
{key: "MAINTENANCE_MODE", values: []string{"on"}},
|
||||
{key: "MESSAGE_MAX_AGE", values: []string{"30d", "0", "-1h"}},
|
||||
{key: "QUEUE_MAX_AGE", values: []string{"720", "0s", "-24h"}},
|
||||
{key: "SESSION_IDLE_TIMEOUT", values: []string{"a month", "0", "-1m"}},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
for _, value := range test.values {
|
||||
t.Run(test.key+"="+value, func(t *testing.T) {
|
||||
t.Setenv(test.key, value)
|
||||
|
||||
_, err := loadConfig(t)
|
||||
if err == nil {
|
||||
t.Fatalf("%s=%q: got no error", test.key, value)
|
||||
}
|
||||
|
||||
msg := err.Error()
|
||||
if !strings.Contains(msg, test.key) ||
|
||||
!strings.Contains(msg, value) {
|
||||
t.Errorf("error %q does not name %s and %q",
|
||||
msg, test.key, value)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestIRCListenAddrUnsetKeepsDefault(t *testing.T) {
|
||||
// t.Setenv puts back whatever value was there after the test.
|
||||
t.Setenv("IRC_LISTEN_ADDR", "")
|
||||
|
||||
err := os.Unsetenv("IRC_LISTEN_ADDR")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
const want = ":6667"
|
||||
|
||||
cfg := newConfig(t)
|
||||
if cfg.IRCListenAddr != want {
|
||||
t.Errorf("IRCListenAddr = %q, want %q", cfg.IRCListenAddr, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestIRCListenAddrEmptyTurnsListenerOff(t *testing.T) {
|
||||
t.Setenv("IRC_LISTEN_ADDR", "")
|
||||
|
||||
cfg := newConfig(t)
|
||||
if cfg.IRCListenAddr != "" {
|
||||
t.Errorf("IRCListenAddr = %q, want empty", cfg.IRCListenAddr)
|
||||
}
|
||||
}
|
||||
+34
-15
@@ -5,9 +5,11 @@ import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"embed"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"log/slog"
|
||||
"net/url"
|
||||
"sort"
|
||||
"strconv"
|
||||
"strings"
|
||||
@@ -22,6 +24,10 @@ import (
|
||||
|
||||
const minMigrationParts = 2
|
||||
|
||||
var errForeignKeysInDBURL = errors.New(
|
||||
"DBURL must not set foreign_keys, which the server always turns on",
|
||||
)
|
||||
|
||||
// SchemaFiles contains embedded SQL migration files.
|
||||
//
|
||||
//go:embed schema/*.sql
|
||||
@@ -87,9 +93,36 @@ func (database *Database) GetDB() *sql.DB {
|
||||
func (database *Database) connect(ctx context.Context) error {
|
||||
dbURL := database.params.Config.DBURL
|
||||
if dbURL == "" {
|
||||
dbURL = "file:///var/lib/neoirc/state.db?_journal_mode=WAL&_busy_timeout=5000"
|
||||
dbURL = config.DefaultDBURL
|
||||
}
|
||||
|
||||
// SQLite keeps the foreign keys setting per connection. The driver
|
||||
// runs each _pragma parameter on every connection it opens. So the
|
||||
// one added below also covers the connection the pool opens after
|
||||
// a cancelled query breaks the old one. A foreign_keys pragma in
|
||||
// DBURL could undo it, because the driver sorts the pragmas.
|
||||
_, query, hasQuery := strings.Cut(dbURL, "?")
|
||||
|
||||
urlParams, err := url.ParseQuery(query)
|
||||
if err != nil {
|
||||
return fmt.Errorf("parse DBURL: %w", err)
|
||||
}
|
||||
|
||||
for _, pragma := range urlParams["_pragma"] {
|
||||
if strings.Contains(strings.ToLower(pragma), "foreign_keys") {
|
||||
return fmt.Errorf(
|
||||
"%w: _pragma=%s", errForeignKeysInDBURL, pragma,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
separator := "?"
|
||||
if hasQuery {
|
||||
separator = "&"
|
||||
}
|
||||
|
||||
dbURL += separator + "_pragma=foreign_keys(1)"
|
||||
|
||||
database.log.Info(
|
||||
"connecting to database", "url", dbURL,
|
||||
)
|
||||
@@ -109,20 +142,6 @@ func (database *Database) connect(ctx context.Context) error {
|
||||
database.conn = conn
|
||||
database.log.Info("database connected")
|
||||
|
||||
_, err = database.conn.ExecContext(
|
||||
ctx, "PRAGMA foreign_keys = ON",
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("enable foreign keys: %w", err)
|
||||
}
|
||||
|
||||
_, err = database.conn.ExecContext(
|
||||
ctx, "PRAGMA busy_timeout = 5000",
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("set busy timeout: %w", err)
|
||||
}
|
||||
|
||||
return database.runMigrations(ctx)
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,278 @@
|
||||
package db_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"net/url"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"go.uber.org/fx/fxtest"
|
||||
"sneak.berlin/go/neoirc/internal/config"
|
||||
"sneak.berlin/go/neoirc/internal/db"
|
||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
||||
"sneak.berlin/go/neoirc/internal/globals"
|
||||
"sneak.berlin/go/neoirc/internal/logger"
|
||||
)
|
||||
|
||||
const wantBusyTimeoutMS = 5000
|
||||
|
||||
const (
|
||||
// endlessQuery counts the rows of a recursive query that never
|
||||
// stops, so it runs until its context ends.
|
||||
endlessQuery = `WITH RECURSIVE n(x) AS
|
||||
(SELECT 1 UNION ALL SELECT x + 1 FROM n)
|
||||
SELECT COUNT(*) FROM n`
|
||||
|
||||
endlessQueryTimeout = 100 * time.Millisecond
|
||||
)
|
||||
|
||||
// TestDefaultDBURLSetsWALAndBusyTimeout opens a file database
|
||||
// with the default URL's parameters the way the server does,
|
||||
// and checks the journal mode and busy timeout it ends up with.
|
||||
func TestDefaultDBURLSetsWALAndBusyTimeout(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
_, params, _ := strings.Cut(config.DefaultDBURL, "?")
|
||||
dbURL := "file://" + filepath.Join(t.TempDir(), "state.db") +
|
||||
"?" + params
|
||||
|
||||
lifecycle := fxtest.NewLifecycle(t)
|
||||
|
||||
log, err := logger.New(lifecycle, logger.Params{
|
||||
Globals: &globals.Globals{},
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
database, err := db.New(lifecycle, db.Params{
|
||||
Logger: log,
|
||||
Config: &config.Config{DBURL: dbURL},
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
lifecycle.RequireStart()
|
||||
t.Cleanup(lifecycle.RequireStop)
|
||||
|
||||
var journalMode string
|
||||
|
||||
err = database.GetDB().QueryRowContext(
|
||||
t.Context(), "PRAGMA journal_mode",
|
||||
).Scan(&journalMode)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if journalMode != "wal" {
|
||||
t.Errorf("journal_mode = %q, want %q", journalMode, "wal")
|
||||
}
|
||||
|
||||
var busyTimeout int
|
||||
|
||||
err = database.GetDB().QueryRowContext(
|
||||
t.Context(), "PRAGMA busy_timeout",
|
||||
).Scan(&busyTimeout)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if busyTimeout != wantBusyTimeoutMS {
|
||||
t.Errorf(
|
||||
"busy_timeout = %d, want %d",
|
||||
busyTimeout, wantBusyTimeoutMS,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// TestForeignKeysOnAfterCancelledQuery cancels a query while it
|
||||
// runs, which makes the pool close its only connection and open a
|
||||
// new one. A TEMP table lasts only as long as its connection, so
|
||||
// its absence shows the connection was replaced. The test then
|
||||
// checks that the file database keeps its tables and that the new
|
||||
// connection has foreign keys on.
|
||||
func TestForeignKeysOnAfterCancelledQuery(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
_, defaultParams, _ := strings.Cut(config.DefaultDBURL, "?")
|
||||
|
||||
urlParams := map[string]string{
|
||||
"default parameters": "?" + defaultParams,
|
||||
"no parameters": "",
|
||||
}
|
||||
|
||||
for name, params := range urlParams {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
dbURL := "file://" +
|
||||
filepath.Join(t.TempDir(), "state.db") + params
|
||||
|
||||
database, err := startDatabase(t, dbURL)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
_, err = database.GetDB().ExecContext(
|
||||
t.Context(), "CREATE TEMP TABLE first_connection (x)",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
ctx, cancel := context.WithTimeout(
|
||||
t.Context(), endlessQueryTimeout,
|
||||
)
|
||||
defer cancel()
|
||||
|
||||
_, err = database.GetDB().ExecContext(ctx, endlessQuery)
|
||||
if !errors.Is(err, context.DeadlineExceeded) {
|
||||
t.Fatalf("endless query: err = %v", err)
|
||||
}
|
||||
|
||||
tempTables := queryInt(
|
||||
t, database, "SELECT COUNT(*) FROM sqlite_temp_schema",
|
||||
)
|
||||
if tempTables != 0 {
|
||||
t.Fatal("the pool kept its first connection")
|
||||
}
|
||||
|
||||
migrations := queryInt(
|
||||
t, database, "SELECT COUNT(*) FROM schema_migrations",
|
||||
)
|
||||
if migrations == 0 {
|
||||
t.Error("schema_migrations is empty")
|
||||
}
|
||||
|
||||
foreignKeys := queryInt(t, database, "PRAGMA foreign_keys")
|
||||
if foreignKeys != 1 {
|
||||
t.Errorf("foreign_keys = %d, want 1", foreignKeys)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestNewURLKeepsDataAfterCancelledQuery cancels a query on a test
|
||||
// database while it runs, which makes the pool close its only
|
||||
// connection and open a new one. A TEMP table lasts only as long as
|
||||
// its connection, so its absence shows the connection was replaced.
|
||||
// The database must still have its tables and rows.
|
||||
func TestNewURLKeepsDataAfterCancelledQuery(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
database, err := startDatabase(t, dbtest.NewURL(t))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
_, err = database.GetOrCreateChannel(t.Context(), "#test")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
_, err = database.GetDB().ExecContext(
|
||||
t.Context(), "CREATE TEMP TABLE first_connection (x)",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
ctx, cancel := context.WithTimeout(t.Context(), endlessQueryTimeout)
|
||||
defer cancel()
|
||||
|
||||
_, err = database.GetDB().ExecContext(ctx, endlessQuery)
|
||||
if !errors.Is(err, context.DeadlineExceeded) {
|
||||
t.Fatalf("endless query: err = %v", err)
|
||||
}
|
||||
|
||||
tempTables := queryInt(
|
||||
t, database, "SELECT COUNT(*) FROM sqlite_temp_schema",
|
||||
)
|
||||
if tempTables != 0 {
|
||||
t.Fatal("the pool kept its first connection")
|
||||
}
|
||||
|
||||
channels := queryInt(t, database, "SELECT COUNT(*) FROM channels")
|
||||
if channels != 1 {
|
||||
t.Errorf("channels = %d, want 1", channels)
|
||||
}
|
||||
}
|
||||
|
||||
// TestDBURLSettingForeignKeysFailsStartup checks that the database
|
||||
// refuses to start when DBURL sets foreign_keys itself, however it
|
||||
// is spelled.
|
||||
func TestDBURLSettingForeignKeysFailsStartup(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
pragmas := []string{
|
||||
"foreign_keys(0)",
|
||||
"foreign_keys(off)",
|
||||
"foreign_keys=0",
|
||||
"FOREIGN_KEYS(FALSE)",
|
||||
" Foreign_Keys = 1",
|
||||
}
|
||||
|
||||
for _, pragma := range pragmas {
|
||||
t.Run(pragma, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
dbURL := "file://" +
|
||||
filepath.Join(t.TempDir(), "state.db") +
|
||||
"?_pragma=" + url.QueryEscape(pragma)
|
||||
|
||||
_, err := startDatabase(t, dbURL)
|
||||
if err == nil {
|
||||
t.Fatal("the database started")
|
||||
}
|
||||
|
||||
if !strings.Contains(err.Error(), "DBURL") {
|
||||
t.Errorf("error %q does not name DBURL", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// startDatabase starts a Database for dbURL the way the server does.
|
||||
// It returns the error that stopped it from starting, if any.
|
||||
func startDatabase(t *testing.T, dbURL string) (*db.Database, error) {
|
||||
t.Helper()
|
||||
|
||||
lifecycle := fxtest.NewLifecycle(t)
|
||||
|
||||
log, err := logger.New(lifecycle, logger.Params{
|
||||
Globals: &globals.Globals{},
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
database, err := db.New(lifecycle, db.Params{
|
||||
Logger: log,
|
||||
Config: &config.Config{DBURL: dbURL},
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
t.Cleanup(lifecycle.RequireStop)
|
||||
|
||||
return database, lifecycle.Start(t.Context())
|
||||
}
|
||||
|
||||
// queryInt runs a query that returns a single number.
|
||||
func queryInt(t *testing.T, database *db.Database, query string) int {
|
||||
t.Helper()
|
||||
|
||||
var result int
|
||||
|
||||
err := database.GetDB().QueryRowContext(t.Context(), query).Scan(&result)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
return result
|
||||
}
|
||||
@@ -17,3 +17,14 @@ func IsUniqueConstraintError(err error) bool {
|
||||
|
||||
return sqliteErr.Code() == sqlite3.SQLITE_CONSTRAINT_UNIQUE
|
||||
}
|
||||
|
||||
// IsForeignKeyConstraintError reports whether err is a
|
||||
// SQLite foreign-key constraint violation.
|
||||
func IsForeignKeyConstraintError(err error) bool {
|
||||
var sqliteErr *sqlite.Error
|
||||
if !errors.As(err, &sqliteErr) {
|
||||
return false
|
||||
}
|
||||
|
||||
return sqliteErr.Code() == sqlite3.SQLITE_CONSTRAINT_FOREIGNKEY
|
||||
}
|
||||
|
||||
+20
-11
@@ -5,21 +5,16 @@ import (
|
||||
"database/sql"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
||||
)
|
||||
|
||||
//nolint:gochecknoglobals // test counter
|
||||
var testDBCounter atomic.Int64
|
||||
|
||||
// NewTestDatabase creates an in-memory database for testing.
|
||||
func NewTestDatabase() (*Database, error) {
|
||||
counter := testDBCounter.Add(1)
|
||||
func NewTestDatabase(tb testing.TB) (*Database, error) {
|
||||
tb.Helper()
|
||||
|
||||
dsn := fmt.Sprintf(
|
||||
"file:testdb%d?mode=memory"+
|
||||
"&cache=shared&_pragma=foreign_keys(1)",
|
||||
counter,
|
||||
)
|
||||
dsn := dbtest.NewURL(tb) + "&_pragma=foreign_keys(1)"
|
||||
|
||||
conn, err := sql.Open("sqlite", dsn)
|
||||
if err != nil {
|
||||
@@ -58,3 +53,17 @@ func (database *Database) Close() error {
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// ExecForTest runs a raw statement, such as a trigger that
|
||||
// makes a write fail.
|
||||
func (database *Database) ExecForTest(
|
||||
ctx context.Context,
|
||||
query string,
|
||||
) error {
|
||||
_, err := database.conn.ExecContext(ctx, query)
|
||||
if err != nil {
|
||||
return fmt.Errorf("exec for test: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
+718
-192
File diff suppressed because it is too large
Load Diff
+327
-36
@@ -2,6 +2,7 @@ package db_test
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"slices"
|
||||
"testing"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/db"
|
||||
@@ -12,7 +13,7 @@ import (
|
||||
func setupTestDB(t *testing.T) *db.Database {
|
||||
t.Helper()
|
||||
|
||||
database, err := db.NewTestDatabase()
|
||||
database, err := db.NewTestDatabase(t)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@@ -411,7 +412,7 @@ func TestJoinAndPart(t *testing.T) {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = database.PartChannel(ctx, chID, sid)
|
||||
err = database.PartChannelAndDeleteIfEmpty(ctx, chID, sid)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@@ -422,7 +423,10 @@ func TestJoinAndPart(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestDeleteChannelIfEmpty(t *testing.T) {
|
||||
// TestPartChannelAndDeleteIfEmpty checks that a part keeps
|
||||
// a channel another session is still on and deletes the
|
||||
// channel when its last member parts.
|
||||
func TestPartChannelAndDeleteIfEmpty(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
database := setupTestDB(t)
|
||||
@@ -435,9 +439,13 @@ func TestDeleteChannelIfEmpty(t *testing.T) {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
sid, _, _, err := database.CreateSession(ctx, "temp", "", "", "")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
nicks := []string{"temp1", "temp2"}
|
||||
sids := make([]int64, 0, len(nicks))
|
||||
|
||||
for _, nick := range nicks {
|
||||
sid, _, _, createErr := database.CreateSession(ctx, nick, "", "", "")
|
||||
if createErr != nil {
|
||||
t.Fatal(createErr)
|
||||
}
|
||||
|
||||
err = database.JoinChannel(ctx, chID, sid)
|
||||
@@ -445,12 +453,20 @@ func TestDeleteChannelIfEmpty(t *testing.T) {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = database.PartChannel(ctx, chID, sid)
|
||||
sids = append(sids, sid)
|
||||
}
|
||||
|
||||
err = database.PartChannelAndDeleteIfEmpty(ctx, chID, sids[0])
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = database.DeleteChannelIfEmpty(ctx, chID)
|
||||
_, err = database.GetChannelByName(ctx, "#empty")
|
||||
if err != nil {
|
||||
t.Fatalf("channel deleted while a member is on it: %v", err)
|
||||
}
|
||||
|
||||
err = database.PartChannelAndDeleteIfEmpty(ctx, chID, sids[1])
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@@ -619,7 +635,7 @@ func TestInsertMessage(t *testing.T) {
|
||||
body := json.RawMessage(`["hello"]`)
|
||||
|
||||
dbID, msgUUID, err := database.InsertMessage(
|
||||
ctx, "PRIVMSG", "poller", "#test", nil, body, nil,
|
||||
ctx, "PRIVMSG", "poller", "#test", 0, 0, nil, body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
@@ -653,13 +669,13 @@ func TestPollMessages(t *testing.T) {
|
||||
body := json.RawMessage(`["hello"]`)
|
||||
|
||||
dbID, _, err := database.InsertMessage(
|
||||
ctx, "PRIVMSG", "poller", "#test", nil, body, nil,
|
||||
ctx, "PRIVMSG", "poller", "#test", 0, 0, nil, body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = database.EnqueueToSession(ctx, sid, dbID)
|
||||
err = database.EnqueueToSession(ctx, sid, dbID, 0)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@@ -706,11 +722,16 @@ func TestGetHistory(t *testing.T) {
|
||||
database := setupTestDB(t)
|
||||
ctx := t.Context()
|
||||
|
||||
chID, err := database.GetOrCreateChannel(ctx, "#hist")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
const msgCount = 10
|
||||
|
||||
for range msgCount {
|
||||
_, _, err := database.InsertMessage(
|
||||
ctx, "PRIVMSG", "user", "#hist",
|
||||
_, _, err = database.InsertMessage(
|
||||
ctx, "PRIVMSG", "user", "#hist", 0, chID,
|
||||
nil, json.RawMessage(`["msg"]`), nil,
|
||||
)
|
||||
if err != nil {
|
||||
@@ -721,7 +742,7 @@ func TestGetHistory(t *testing.T) {
|
||||
const histLimit = 5
|
||||
|
||||
msgs, err := database.GetHistory(
|
||||
ctx, "#hist", 0, histLimit,
|
||||
ctx, 0, chID, "", histLimit,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
@@ -737,44 +758,209 @@ func TestGetHistory(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestDeleteSession(t *testing.T) {
|
||||
// TestGetHistoryReusedNames checks that history follows the
|
||||
// session and the channel row, not the nick or the channel
|
||||
// name: a session that takes a released nick, and a channel
|
||||
// created again under a deleted one's name, start with none.
|
||||
func TestGetHistoryReusedNames(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
database := setupTestDB(t)
|
||||
ctx := t.Context()
|
||||
|
||||
sid, _, _, err := database.CreateSession(
|
||||
ctx, "deleteme", "", "", "",
|
||||
historyLen := func(toSessionID, toChannelID int64) int {
|
||||
t.Helper()
|
||||
|
||||
msgs, err := database.GetHistory(
|
||||
ctx, toSessionID, toChannelID, "", 0,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
chID, err := database.GetOrCreateChannel(
|
||||
ctx, "#delchan",
|
||||
return len(msgs)
|
||||
}
|
||||
|
||||
oldSID, _, _, err := database.CreateSession(
|
||||
ctx, "reused", "", "", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = database.JoinChannel(ctx, chID, sid)
|
||||
oldChID, err := database.GetOrCreateChannel(ctx, "#reused")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = database.DeleteSession(ctx, sid)
|
||||
err = database.JoinChannel(ctx, oldChID, oldSID)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
body := json.RawMessage(`["hi"]`)
|
||||
|
||||
_, _, err = database.InsertMessage(
|
||||
ctx, "PRIVMSG", "sender", "reused", oldSID, 0,
|
||||
nil, body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
_, _, err = database.InsertMessage(
|
||||
ctx, "PRIVMSG", "sender", "#reused", 0, oldChID,
|
||||
nil, body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if historyLen(oldSID, 0) != 1 || historyLen(0, oldChID) != 1 {
|
||||
t.Fatal("expected one DM and one channel message")
|
||||
}
|
||||
|
||||
// The session is the channel's only member, so quitting
|
||||
// deletes the channel too.
|
||||
_, err = database.QuitSession(ctx, oldSID, "reused", nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
newSID, _, _, err := database.CreateSession(
|
||||
ctx, "reused", "", "", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
newChID, err := database.GetOrCreateChannel(ctx, "#reused")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if historyLen(newSID, 0) != 0 || historyLen(0, newChID) != 0 {
|
||||
t.Fatal("expected no history for the names' new holders")
|
||||
}
|
||||
}
|
||||
|
||||
// TestQuitSession checks that QuitSession deletes the
|
||||
// session, keeps a channel another session is still on,
|
||||
// deletes a channel it leaves with no members, and queues
|
||||
// one QUIT to the other session; and that a second call for
|
||||
// the same session changes nothing.
|
||||
func TestQuitSession(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
database := setupTestDB(t)
|
||||
ctx := t.Context()
|
||||
|
||||
sid, sharedID, _ := createSessionWithChannels(
|
||||
t, database, "deleteme", "#shared", "#alone",
|
||||
)
|
||||
|
||||
peerSID, peerClientID, _, err := database.CreateSession(
|
||||
ctx, "peer", "", "", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = database.JoinChannel(ctx, sharedID, peerSID)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
body := json.RawMessage(`["bye"]`)
|
||||
|
||||
peerIDs, err := database.QuitSession(ctx, sid, "deleteme", body)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if !slices.Equal(peerIDs, []int64{peerSID}) {
|
||||
t.Fatalf("got peers %v, want [%d]", peerIDs, peerSID)
|
||||
}
|
||||
|
||||
_, err = database.GetSessionByNick(ctx, "deleteme")
|
||||
if err == nil {
|
||||
t.Fatal("session should be deleted")
|
||||
}
|
||||
|
||||
ids, _ := database.GetChannelMemberIDs(ctx, chID)
|
||||
if len(ids) != 0 {
|
||||
t.Fatal("expected no members after deletion")
|
||||
ids, _ := database.GetChannelMemberIDs(ctx, sharedID)
|
||||
if !slices.Equal(ids, []int64{peerSID}) {
|
||||
t.Fatalf("#shared members: got %v, want [%d]", ids, peerSID)
|
||||
}
|
||||
|
||||
_, err = database.GetChannelByName(ctx, "#alone")
|
||||
if err == nil {
|
||||
t.Fatal("expected the emptied channel to be deleted")
|
||||
}
|
||||
|
||||
checkOneQuitQueued(t, database, peerClientID, "deleteme")
|
||||
|
||||
peerIDs, err = database.QuitSession(ctx, sid, "deleteme", body)
|
||||
if err != nil || len(peerIDs) != 0 {
|
||||
t.Fatalf("second quit: got %v, %v; want none", peerIDs, err)
|
||||
}
|
||||
|
||||
checkOneQuitQueued(t, database, peerClientID, "deleteme")
|
||||
}
|
||||
|
||||
// checkOneQuitQueued fails the test unless the queue of the
|
||||
// client clientID holds one message, a QUIT from nick.
|
||||
func checkOneQuitQueued(
|
||||
t *testing.T,
|
||||
database *db.Database,
|
||||
clientID int64,
|
||||
nick string,
|
||||
) {
|
||||
t.Helper()
|
||||
|
||||
msgs, _, err := database.PollMessages(t.Context(), clientID, 0, 0)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if len(msgs) != 1 || msgs[0].Command != "QUIT" || msgs[0].From != nick {
|
||||
t.Fatalf("queue: got %v, want one QUIT from %s", msgs, nick)
|
||||
}
|
||||
}
|
||||
|
||||
// TestLogoutClientFailureKeepsClient checks that when the
|
||||
// session of a logout's last client cannot be deleted,
|
||||
// LogoutClient fails and the client stays logged in.
|
||||
func TestLogoutClientFailureKeepsClient(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
database := setupTestDB(t)
|
||||
ctx := t.Context()
|
||||
|
||||
sid, clientID, token, err := database.CreateSession(
|
||||
ctx, "stuck", "", "", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
_, err = database.GetDB().ExecContext(ctx,
|
||||
`CREATE TRIGGER keep_sessions
|
||||
BEFORE DELETE ON sessions
|
||||
BEGIN
|
||||
SELECT RAISE(ABORT, 'sessions are kept');
|
||||
END`)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
_, err = database.LogoutClient(ctx, sid, clientID, "stuck", nil)
|
||||
if err == nil {
|
||||
t.Fatal("logout succeeded although the session was kept")
|
||||
}
|
||||
|
||||
_, _, nick, err := database.GetSessionByToken(ctx, token)
|
||||
if err != nil || nick != "stuck" {
|
||||
t.Fatalf("client gone after a failed logout: %q, %v", nick, err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -863,7 +1049,7 @@ func TestEnqueueToClient(t *testing.T) {
|
||||
body := json.RawMessage(`["test"]`)
|
||||
|
||||
dbID, _, err := database.InsertMessage(
|
||||
ctx, "PRIVMSG", "sender", "#ch", nil, body, nil,
|
||||
ctx, "PRIVMSG", "sender", "#ch", 0, 0, nil, body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
@@ -1253,17 +1439,6 @@ func TestChannelInviteCRUD(t *testing.T) {
|
||||
if !has {
|
||||
t.Fatal("should have invite")
|
||||
}
|
||||
|
||||
// Clear invite.
|
||||
err = database.ClearChannelInvite(ctx, chID, sid)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
has, _ = database.HasChannelInvite(ctx, chID, sid)
|
||||
if has {
|
||||
t.Fatal("invite should be cleared")
|
||||
}
|
||||
}
|
||||
|
||||
func TestChannelSecret(t *testing.T) {
|
||||
@@ -1491,3 +1666,119 @@ func TestChannelUserLimit(t *testing.T) {
|
||||
t.Fatalf("expected 0, got %d", limit)
|
||||
}
|
||||
}
|
||||
|
||||
// TestSetSessionUserModesIsAtomic makes the is_oper write
|
||||
// fail after the is_wallops write has run, and checks that
|
||||
// the wallops change was rolled back.
|
||||
func TestSetSessionUserModesIsAtomic(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
database := setupTestDB(t)
|
||||
ctx := t.Context()
|
||||
|
||||
sessionID, _, _, err := database.CreateSession(
|
||||
ctx, "alice", "", "", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = database.ExecForTest(ctx,
|
||||
`CREATE TRIGGER reject_oper
|
||||
BEFORE UPDATE OF is_oper ON sessions
|
||||
BEGIN SELECT RAISE(ABORT, 'oper write rejected');
|
||||
END`,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
wallops := true
|
||||
oper := false
|
||||
|
||||
err = database.SetSessionUserModes(
|
||||
ctx, sessionID, &wallops, &oper,
|
||||
)
|
||||
if err == nil {
|
||||
t.Fatal("expected the rejected oper write to fail")
|
||||
}
|
||||
|
||||
gotWallops, err := database.IsSessionWallops(
|
||||
ctx, sessionID,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if gotWallops {
|
||||
t.Error("wallops was stored although the change failed")
|
||||
}
|
||||
}
|
||||
|
||||
// TestSetSessionUserModesAppliesBoth checks that both flags
|
||||
// are written, and that a nil flag is left as it is.
|
||||
func TestSetSessionUserModesAppliesBoth(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
database := setupTestDB(t)
|
||||
ctx := t.Context()
|
||||
|
||||
sessionID, _, _, err := database.CreateSession(
|
||||
ctx, "alice", "", "", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
err = database.SetSessionOper(ctx, sessionID, true)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
wallops := true
|
||||
oper := false
|
||||
|
||||
err = database.SetSessionUserModes(
|
||||
ctx, sessionID, &wallops, &oper,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
gotWallops, err := database.IsSessionWallops(
|
||||
ctx, sessionID,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
gotOper, err := database.IsSessionOper(ctx, sessionID)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if !gotWallops || gotOper {
|
||||
t.Errorf(
|
||||
"want wallops=true oper=false, got %v/%v",
|
||||
gotWallops, gotOper,
|
||||
)
|
||||
}
|
||||
|
||||
err = database.SetSessionUserModes(
|
||||
ctx, sessionID, nil, nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
gotWallops, err = database.IsSessionWallops(
|
||||
ctx, sessionID,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if !gotWallops {
|
||||
t.Error("a nil wallops flag cleared wallops")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,6 +10,7 @@ CREATE TABLE IF NOT EXISTS sessions (
|
||||
hostname TEXT NOT NULL DEFAULT '',
|
||||
ip TEXT NOT NULL DEFAULT '',
|
||||
is_oper INTEGER NOT NULL DEFAULT 0,
|
||||
is_wallops INTEGER NOT NULL DEFAULT 0,
|
||||
password_hash TEXT NOT NULL DEFAULT '',
|
||||
signing_key TEXT NOT NULL DEFAULT '',
|
||||
away_message TEXT NOT NULL DEFAULT '',
|
||||
@@ -84,19 +85,25 @@ CREATE TABLE IF NOT EXISTS channel_members (
|
||||
UNIQUE(channel_id, session_id)
|
||||
);
|
||||
|
||||
-- Messages: IRC envelope format
|
||||
-- Messages: IRC envelope format. to_session_id is the session a DM
|
||||
-- or INVITE was sent to, to_channel_id the channel a channel message
|
||||
-- was sent to. History is selected by these ids because nicks and
|
||||
-- channel names are reused once released, and ids are not.
|
||||
CREATE TABLE IF NOT EXISTS messages (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
uuid TEXT NOT NULL UNIQUE,
|
||||
command TEXT NOT NULL DEFAULT 'PRIVMSG',
|
||||
msg_from TEXT NOT NULL DEFAULT '',
|
||||
msg_to TEXT NOT NULL DEFAULT '',
|
||||
to_session_id INTEGER REFERENCES sessions(id) ON DELETE SET NULL,
|
||||
to_channel_id INTEGER REFERENCES channels(id) ON DELETE SET NULL,
|
||||
params TEXT NOT NULL DEFAULT '[]',
|
||||
body TEXT NOT NULL DEFAULT '[]',
|
||||
meta TEXT NOT NULL DEFAULT '{}',
|
||||
created_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
CREATE INDEX IF NOT EXISTS idx_messages_to_id ON messages(msg_to, id);
|
||||
CREATE INDEX IF NOT EXISTS idx_messages_to_session ON messages(to_session_id, id);
|
||||
CREATE INDEX IF NOT EXISTS idx_messages_to_channel ON messages(to_channel_id, id);
|
||||
CREATE INDEX IF NOT EXISTS idx_messages_created ON messages(created_at);
|
||||
|
||||
-- Spent hashcash tokens for replay prevention (1-year TTL)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
// Package dbtest gives each test a database of its own. Only tests
|
||||
// may import it.
|
||||
package dbtest
|
||||
|
||||
import (
|
||||
"crypto/rand"
|
||||
"database/sql"
|
||||
"testing"
|
||||
|
||||
_ "modernc.org/sqlite" // registers the sqlite driver
|
||||
)
|
||||
|
||||
// NewURL returns the URL of a new, empty in-memory database for one
|
||||
// test. SQLite deletes an in-memory database when its last connection
|
||||
// closes. A pool closes a connection when a query on it is cancelled
|
||||
// while it runs. So this function holds a connection of its own open
|
||||
// until the test ends.
|
||||
func NewURL(tb testing.TB) string {
|
||||
tb.Helper()
|
||||
|
||||
// A random name, so that no other test can share the database.
|
||||
dbURL := "file:" + rand.Text() + "?mode=memory&cache=shared"
|
||||
|
||||
pool, err := sql.Open("sqlite", dbURL)
|
||||
if err != nil {
|
||||
tb.Fatalf("open test database: %v", err)
|
||||
}
|
||||
|
||||
tb.Cleanup(func() { _ = pool.Close() })
|
||||
|
||||
conn, err := pool.Conn(tb.Context())
|
||||
if err != nil {
|
||||
tb.Fatalf("connect to test database: %v", err)
|
||||
}
|
||||
|
||||
tb.Cleanup(func() { _ = conn.Close() })
|
||||
|
||||
return dbURL
|
||||
}
|
||||
+207
-415
File diff suppressed because it is too large
Load Diff
+1986
-26
File diff suppressed because it is too large
Load Diff
@@ -8,7 +8,12 @@ import (
|
||||
"sneak.berlin/go/neoirc/pkg/irc"
|
||||
)
|
||||
|
||||
const minPasswordLength = 8
|
||||
// A session password is 8 to 72 bytes; bcrypt cannot hash
|
||||
// a longer one.
|
||||
const (
|
||||
minPasswordLength = 8
|
||||
maxPasswordLength = 72
|
||||
)
|
||||
|
||||
// HandleLogin authenticates a user with nick and password.
|
||||
func (hdlr *Handlers) HandleLogin() http.HandlerFunc {
|
||||
@@ -149,12 +154,13 @@ func (hdlr *Handlers) handlePass(
|
||||
|
||||
password := lines[0]
|
||||
|
||||
if len(password) < minPasswordLength {
|
||||
if len(password) < minPasswordLength ||
|
||||
len(password) > maxPasswordLength {
|
||||
hdlr.respondIRCError(
|
||||
writer, request, clientID, sessionID,
|
||||
irc.ErrNeedMoreParams, nick,
|
||||
[]string{irc.CmdPass},
|
||||
"Password must be at least 8 characters",
|
||||
"Password must be 8 to 72 bytes",
|
||||
)
|
||||
|
||||
return
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/db"
|
||||
)
|
||||
|
||||
// SetPollMessages makes HandleGetMessages read the client
|
||||
// output queue with poll in place of Database.PollMessages.
|
||||
func (hdlr *Handlers) SetPollMessages(
|
||||
poll func(
|
||||
ctx context.Context,
|
||||
clientID, afterQueueID int64,
|
||||
limit int,
|
||||
) ([]db.IRCMessage, int64, error),
|
||||
) {
|
||||
hdlr.pollMessages = poll
|
||||
}
|
||||
@@ -61,10 +61,19 @@ type Handlers struct {
|
||||
broker *broker.Broker
|
||||
svc *service.Service
|
||||
hashcashVal *hashcash.Validator
|
||||
channelHashcash *hashcash.ChannelValidator
|
||||
loginLimiter *ratelimit.Limiter
|
||||
stats *stats.Tracker
|
||||
cancelCleanup context.CancelFunc
|
||||
|
||||
// pollMessages is Database.PollMessages, with which
|
||||
// HandleGetMessages reads the client output queue. Tests
|
||||
// replace it to act just after a read, or to make a read
|
||||
// fail.
|
||||
pollMessages func(
|
||||
ctx context.Context,
|
||||
clientID, afterQueueID int64,
|
||||
limit int,
|
||||
) ([]db.IRCMessage, int64, error)
|
||||
}
|
||||
|
||||
// New creates a new Handlers instance.
|
||||
@@ -94,9 +103,9 @@ func New(
|
||||
broker: params.Broker,
|
||||
svc: params.Service,
|
||||
hashcashVal: hashcash.NewValidator(resource),
|
||||
channelHashcash: hashcash.NewChannelValidator(),
|
||||
loginLimiter: ratelimit.New(loginRate, loginBurst),
|
||||
stats: params.Stats,
|
||||
pollMessages: params.Database.PollMessages,
|
||||
}
|
||||
|
||||
lifecycle.Append(fx.Hook{
|
||||
|
||||
@@ -0,0 +1,304 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/neoirc/pkg/irc"
|
||||
)
|
||||
|
||||
// dispatchOperCommand routes the server operator commands
|
||||
// OPER, KILL and WALLOPS to their handlers.
|
||||
func (hdlr *Handlers) dispatchOperCommand(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
sessionID, clientID int64,
|
||||
nick, command string,
|
||||
bodyLines func() []string,
|
||||
) {
|
||||
switch command {
|
||||
case irc.CmdOper:
|
||||
hdlr.handleOper(
|
||||
writer, request,
|
||||
sessionID, clientID, nick, bodyLines,
|
||||
)
|
||||
case irc.CmdKill:
|
||||
hdlr.handleKill(
|
||||
writer, request,
|
||||
sessionID, clientID, nick, bodyLines,
|
||||
)
|
||||
case irc.CmdWallops:
|
||||
hdlr.handleWallops(
|
||||
writer, request,
|
||||
sessionID, clientID, nick, bodyLines,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// handleUserhost handles USERHOST: user@host for each of
|
||||
// up to five nicks given in the body.
|
||||
func (hdlr *Handlers) handleUserhost(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
sessionID, clientID int64,
|
||||
nick string,
|
||||
bodyLines func() []string,
|
||||
) {
|
||||
lines := bodyLines()
|
||||
if len(lines) == 0 {
|
||||
hdlr.respondIRCError(
|
||||
writer, request, clientID, sessionID,
|
||||
irc.ErrNeedMoreParams, nick,
|
||||
[]string{irc.CmdUserhost},
|
||||
"Not enough parameters",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
reply, err := hdlr.svc.UserhostReply(
|
||||
request.Context(), lines, hdlr.serverName(),
|
||||
)
|
||||
if hdlr.handleServiceError(
|
||||
writer, request, clientID, sessionID, nick, err,
|
||||
) {
|
||||
return
|
||||
}
|
||||
|
||||
hdlr.enqueueNumeric(
|
||||
request.Context(), clientID,
|
||||
irc.RplUserHost, nick, nil, reply,
|
||||
)
|
||||
hdlr.broker.Notify(sessionID)
|
||||
hdlr.respondJSON(writer, request,
|
||||
map[string]string{statusKey: "ok"},
|
||||
http.StatusOK)
|
||||
}
|
||||
|
||||
// handleVersion handles VERSION.
|
||||
func (hdlr *Handlers) handleVersion(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
sessionID, clientID int64,
|
||||
nick string,
|
||||
) {
|
||||
hdlr.enqueueNumeric(
|
||||
request.Context(), clientID, irc.RplVersion, nick,
|
||||
[]string{
|
||||
hdlr.svc.ServerVersion() + ".",
|
||||
hdlr.serverName(),
|
||||
},
|
||||
"",
|
||||
)
|
||||
hdlr.broker.Notify(sessionID)
|
||||
hdlr.respondJSON(writer, request,
|
||||
map[string]string{statusKey: "ok"},
|
||||
http.StatusOK)
|
||||
}
|
||||
|
||||
// handleAdmin handles ADMIN.
|
||||
func (hdlr *Handlers) handleAdmin(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
sessionID, clientID int64,
|
||||
nick string,
|
||||
) {
|
||||
ctx := request.Context()
|
||||
srvName := hdlr.serverName()
|
||||
location1, location2, email := hdlr.svc.AdminLines(srvName)
|
||||
|
||||
hdlr.enqueueNumeric(
|
||||
ctx, clientID, irc.RplAdminMe, nick,
|
||||
[]string{srvName}, "Administrative info",
|
||||
)
|
||||
hdlr.enqueueNumeric(
|
||||
ctx, clientID, irc.RplAdminLoc1, nick, nil, location1,
|
||||
)
|
||||
hdlr.enqueueNumeric(
|
||||
ctx, clientID, irc.RplAdminLoc2, nick, nil, location2,
|
||||
)
|
||||
hdlr.enqueueNumeric(
|
||||
ctx, clientID, irc.RplAdminEmail, nick, nil, email,
|
||||
)
|
||||
hdlr.broker.Notify(sessionID)
|
||||
hdlr.respondJSON(writer, request,
|
||||
map[string]string{statusKey: "ok"},
|
||||
http.StatusOK)
|
||||
}
|
||||
|
||||
// handleInfo handles INFO.
|
||||
func (hdlr *Handlers) handleInfo(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
sessionID, clientID int64,
|
||||
nick string,
|
||||
) {
|
||||
ctx := request.Context()
|
||||
|
||||
for _, line := range hdlr.svc.InfoLines() {
|
||||
hdlr.enqueueNumeric(
|
||||
ctx, clientID, irc.RplInfo, nick, nil, line,
|
||||
)
|
||||
}
|
||||
|
||||
hdlr.enqueueNumeric(
|
||||
ctx, clientID, irc.RplEndOfInfo, nick, nil,
|
||||
"End of /INFO list",
|
||||
)
|
||||
hdlr.broker.Notify(sessionID)
|
||||
hdlr.respondJSON(writer, request,
|
||||
map[string]string{statusKey: "ok"},
|
||||
http.StatusOK)
|
||||
}
|
||||
|
||||
// handleTime handles TIME: the server's local time.
|
||||
func (hdlr *Handlers) handleTime(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
sessionID, clientID int64,
|
||||
nick string,
|
||||
) {
|
||||
hdlr.enqueueNumeric(
|
||||
request.Context(), clientID, irc.RplTime, nick,
|
||||
[]string{hdlr.serverName()},
|
||||
time.Now().Format(time.RFC1123),
|
||||
)
|
||||
hdlr.broker.Notify(sessionID)
|
||||
hdlr.respondJSON(writer, request,
|
||||
map[string]string{statusKey: "ok"},
|
||||
http.StatusOK)
|
||||
}
|
||||
|
||||
// handleKill handles KILL: the body is the target nick and
|
||||
// an optional reason.
|
||||
func (hdlr *Handlers) handleKill(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
sessionID, clientID int64,
|
||||
nick string,
|
||||
bodyLines func() []string,
|
||||
) {
|
||||
lines := bodyLines()
|
||||
|
||||
targetNick := ""
|
||||
if len(lines) > 0 {
|
||||
targetNick = strings.TrimSpace(lines[0])
|
||||
}
|
||||
|
||||
if targetNick == "" {
|
||||
hdlr.respondIRCError(
|
||||
writer, request, clientID, sessionID,
|
||||
irc.ErrNeedMoreParams, nick,
|
||||
[]string{irc.CmdKill},
|
||||
"Not enough parameters",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
reason := ""
|
||||
if len(lines) > 1 {
|
||||
reason = lines[1]
|
||||
}
|
||||
|
||||
err := hdlr.svc.KillUser(
|
||||
request.Context(), sessionID, nick,
|
||||
targetNick, reason,
|
||||
)
|
||||
if hdlr.handleServiceError(
|
||||
writer, request, clientID, sessionID, nick, err,
|
||||
) {
|
||||
return
|
||||
}
|
||||
|
||||
hdlr.respondJSON(writer, request,
|
||||
map[string]string{statusKey: "ok"},
|
||||
http.StatusOK)
|
||||
}
|
||||
|
||||
// handleWallops handles WALLOPS: the body is the message.
|
||||
func (hdlr *Handlers) handleWallops(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
sessionID, clientID int64,
|
||||
nick string,
|
||||
bodyLines func() []string,
|
||||
) {
|
||||
lines := bodyLines()
|
||||
if len(lines) == 0 {
|
||||
hdlr.respondIRCError(
|
||||
writer, request, clientID, sessionID,
|
||||
irc.ErrNeedMoreParams, nick,
|
||||
[]string{irc.CmdWallops},
|
||||
"Not enough parameters",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
err := hdlr.svc.SendWallops(
|
||||
request.Context(), sessionID, nick,
|
||||
strings.Join(lines, " "),
|
||||
)
|
||||
if hdlr.handleServiceError(
|
||||
writer, request, clientID, sessionID, nick, err,
|
||||
) {
|
||||
return
|
||||
}
|
||||
|
||||
hdlr.respondJSON(writer, request,
|
||||
map[string]string{statusKey: "ok"},
|
||||
http.StatusOK)
|
||||
}
|
||||
|
||||
// handleUserMode handles MODE for a nick: a query when the
|
||||
// body is empty, otherwise a change by the mode string in
|
||||
// the body. Only the caller's own nick is allowed.
|
||||
func (hdlr *Handlers) handleUserMode(
|
||||
writer http.ResponseWriter,
|
||||
request *http.Request,
|
||||
sessionID, clientID int64,
|
||||
nick, target string,
|
||||
bodyLines func() []string,
|
||||
) {
|
||||
if target != nick {
|
||||
hdlr.respondIRCError(
|
||||
writer, request, clientID, sessionID,
|
||||
irc.ErrUsersDoNotMatch, nick, nil,
|
||||
"Can't change mode for other users",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
ctx := request.Context()
|
||||
|
||||
var (
|
||||
modes string
|
||||
err error
|
||||
)
|
||||
|
||||
lines := bodyLines()
|
||||
if len(lines) > 0 {
|
||||
modes, err = hdlr.svc.ApplyUserMode(
|
||||
ctx, sessionID, lines[0],
|
||||
)
|
||||
} else {
|
||||
modes, err = hdlr.svc.QueryUserMode(ctx, sessionID)
|
||||
}
|
||||
|
||||
if hdlr.handleServiceError(
|
||||
writer, request, clientID, sessionID, nick, err,
|
||||
) {
|
||||
return
|
||||
}
|
||||
|
||||
hdlr.enqueueNumeric(
|
||||
ctx, clientID, irc.RplUmodeIs, nick, nil, modes,
|
||||
)
|
||||
hdlr.broker.Notify(sessionID)
|
||||
hdlr.respondJSON(writer, request,
|
||||
map[string]string{statusKey: "ok"},
|
||||
http.StatusOK)
|
||||
}
|
||||
@@ -0,0 +1,346 @@
|
||||
package handlers_test
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"sneak.berlin/go/neoirc/pkg/irc"
|
||||
)
|
||||
|
||||
// Each test starts one server and reuses it for all its
|
||||
// checks, and makes as few requests as it can: servers,
|
||||
// sessions and requests are what makes this package's tests
|
||||
// slow.
|
||||
|
||||
// sendAndPoll sends cmd from the session token and returns
|
||||
// the messages after lastID that the session has been sent,
|
||||
// and the ID of the last of them.
|
||||
func sendAndPoll(
|
||||
tserver *testServer,
|
||||
token string,
|
||||
lastID int64,
|
||||
cmd map[string]any,
|
||||
) ([]map[string]any, int64) {
|
||||
tserver.t.Helper()
|
||||
|
||||
tserver.sendCommand(token, cmd)
|
||||
|
||||
return tserver.pollMessages(token, lastID)
|
||||
}
|
||||
|
||||
// newOperSession creates a session for nick, makes it a
|
||||
// server operator, and returns its token and the ID of the
|
||||
// last message it has been sent.
|
||||
func newOperSession(
|
||||
tserver *testServer, nick string,
|
||||
) (string, int64) {
|
||||
tserver.t.Helper()
|
||||
|
||||
token := tserver.createSession(nick)
|
||||
|
||||
_, lastID := sendAndPoll(tserver, token, 0, map[string]any{
|
||||
commandKey: irc.CmdOper,
|
||||
bodyKey: []string{testOperName, testOperPassword},
|
||||
})
|
||||
|
||||
return token, lastID
|
||||
}
|
||||
|
||||
// numericBody returns the first body line of the message in
|
||||
// msgs with the given numeric, and fails the test if there
|
||||
// is none.
|
||||
func numericBody(
|
||||
t *testing.T, msgs []map[string]any, numeric string,
|
||||
) string {
|
||||
t.Helper()
|
||||
|
||||
msg := findNumericWithParams(msgs, numeric)
|
||||
if msg == nil {
|
||||
t.Fatalf("expected numeric %s, got %v", numeric, msgs)
|
||||
}
|
||||
|
||||
lines, _ := msg[bodyKey].([]any)
|
||||
if len(lines) == 0 {
|
||||
return ""
|
||||
}
|
||||
|
||||
line, _ := lines[0].(string)
|
||||
|
||||
return line
|
||||
}
|
||||
|
||||
func TestUserhost(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tserver := newTestServer(t)
|
||||
|
||||
token := tserver.createSession("alice")
|
||||
tserver.createSession("bob")
|
||||
|
||||
_, lastID := tserver.pollMessages(token, 0)
|
||||
|
||||
msgs, lastID := sendAndPoll(tserver, token, lastID, map[string]any{
|
||||
commandKey: irc.CmdUserhost,
|
||||
bodyKey: []string{"alice", "bob"},
|
||||
})
|
||||
|
||||
body := numericBody(t, msgs, "302")
|
||||
if !strings.HasPrefix(body, "alice=+alice@") ||
|
||||
!strings.Contains(body, " bob=+bob@") {
|
||||
t.Errorf("expected alice and bob, got %q", body)
|
||||
}
|
||||
|
||||
msgs, lastID = sendAndPoll(tserver, token, lastID, map[string]any{
|
||||
commandKey: irc.CmdUserhost,
|
||||
bodyKey: []string{"ghost"},
|
||||
})
|
||||
|
||||
body = numericBody(t, msgs, "302")
|
||||
if body != "" {
|
||||
t.Errorf("expected an empty reply for ghost, got %q", body)
|
||||
}
|
||||
|
||||
msgs, _ = sendAndPoll(tserver, token, lastID, map[string]any{
|
||||
commandKey: irc.CmdUserhost,
|
||||
})
|
||||
if !findNumeric(msgs, "461") {
|
||||
t.Errorf("expected ERR_NEEDMOREPARAMS (461), got %v", msgs)
|
||||
}
|
||||
}
|
||||
|
||||
func TestVersionAdminInfoTime(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tserver := newTestServer(t)
|
||||
|
||||
token := tserver.createSession("frank")
|
||||
_, lastID := tserver.pollMessages(token, 0)
|
||||
|
||||
msgs, lastID := sendAndPoll(tserver, token, lastID, map[string]any{
|
||||
commandKey: irc.CmdVersion,
|
||||
})
|
||||
|
||||
params := getNumericParams(findNumericWithParams(msgs, "351"))
|
||||
if len(params) == 0 || params[0] != "neoirc-test-test." {
|
||||
t.Errorf("expected RPL_VERSION neoirc-test-test., got %v", msgs)
|
||||
}
|
||||
|
||||
for _, check := range []struct {
|
||||
command string
|
||||
numerics []string
|
||||
}{
|
||||
{irc.CmdAdmin, []string{"256", "257", "258", "259"}},
|
||||
{irc.CmdInfo, []string{"371", "374"}},
|
||||
{irc.CmdTime, []string{"391"}},
|
||||
} {
|
||||
msgs, lastID = sendAndPoll(tserver, token, lastID, map[string]any{
|
||||
commandKey: check.command,
|
||||
})
|
||||
|
||||
for _, numeric := range check.numerics {
|
||||
if !findNumeric(msgs, numeric) {
|
||||
t.Errorf(
|
||||
"%s: expected %s, got %v",
|
||||
check.command, numeric, msgs,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestKill(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tserver := newTestServerWithOper(t)
|
||||
|
||||
victimToken := tserver.createSession("victim")
|
||||
observerToken := tserver.createSession("observer")
|
||||
notOperToken := tserver.createSession("notoper")
|
||||
operToken, operLastID := newOperSession(tserver, "killer")
|
||||
|
||||
for _, token := range []string{victimToken, observerToken} {
|
||||
tserver.sendCommand(token, map[string]any{
|
||||
commandKey: joinCmd,
|
||||
toKey: "#killtest",
|
||||
})
|
||||
}
|
||||
|
||||
_, notOperLastID := tserver.pollMessages(notOperToken, 0)
|
||||
|
||||
msgs, _ := sendAndPoll(tserver, notOperToken, notOperLastID, map[string]any{
|
||||
commandKey: irc.CmdKill,
|
||||
bodyKey: []string{"victim"},
|
||||
})
|
||||
if !findNumeric(msgs, "481") {
|
||||
t.Errorf("expected ERR_NOPRIVILEGES (481), got %v", msgs)
|
||||
}
|
||||
|
||||
for _, check := range []struct {
|
||||
numeric string
|
||||
body []string
|
||||
}{
|
||||
{"461", []string{}},
|
||||
{"401", []string{"ghost"}},
|
||||
{"483", []string{"killer"}},
|
||||
} {
|
||||
msgs, operLastID = sendAndPoll(tserver, operToken, operLastID, map[string]any{
|
||||
commandKey: irc.CmdKill,
|
||||
bodyKey: check.body,
|
||||
})
|
||||
if !findNumeric(msgs, check.numeric) {
|
||||
t.Errorf(
|
||||
"KILL %v: expected %s, got %v",
|
||||
check.body, check.numeric, msgs,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
_, observerLastID := tserver.pollMessages(observerToken, 0)
|
||||
|
||||
status, result := tserver.sendCommand(operToken, map[string]any{
|
||||
commandKey: irc.CmdKill,
|
||||
bodyKey: []string{"victim", "go away"},
|
||||
})
|
||||
if status != http.StatusOK || result[statusKey] != "ok" {
|
||||
t.Fatalf("expected 200 and status ok, got %d: %v", status, result)
|
||||
}
|
||||
|
||||
msgs, _ = tserver.pollMessages(observerToken, observerLastID)
|
||||
if !findMessage(msgs, irc.CmdQuit, "victim") {
|
||||
t.Errorf("expected the observer to see QUIT, got %v", msgs)
|
||||
}
|
||||
|
||||
status, _ = tserver.getState(victimToken)
|
||||
if status != http.StatusUnauthorized {
|
||||
t.Errorf("expected the victim's session gone, got %d", status)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWallops(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tserver := newTestServerWithOper(t)
|
||||
|
||||
receiverToken := tserver.createSession("receiver")
|
||||
plainToken := tserver.createSession("plain")
|
||||
operToken, operLastID := newOperSession(tserver, "walloper")
|
||||
|
||||
_, receiverLastID := sendAndPoll(tserver, receiverToken, 0, map[string]any{
|
||||
commandKey: modeCmd,
|
||||
toKey: "receiver",
|
||||
bodyKey: []string{"+w"},
|
||||
})
|
||||
_, plainLastID := tserver.pollMessages(plainToken, 0)
|
||||
|
||||
msgs, plainLastID := sendAndPoll(tserver, plainToken, plainLastID, map[string]any{
|
||||
commandKey: irc.CmdWallops,
|
||||
bodyKey: []string{"not allowed"},
|
||||
})
|
||||
if !findNumeric(msgs, "481") {
|
||||
t.Errorf("expected ERR_NOPRIVILEGES (481), got %v", msgs)
|
||||
}
|
||||
|
||||
msgs, _ = sendAndPoll(tserver, operToken, operLastID, map[string]any{
|
||||
commandKey: irc.CmdWallops,
|
||||
})
|
||||
if !findNumeric(msgs, "461") {
|
||||
t.Errorf("expected ERR_NEEDMOREPARAMS (461), got %v", msgs)
|
||||
}
|
||||
|
||||
tserver.sendCommand(operToken, map[string]any{
|
||||
commandKey: irc.CmdWallops,
|
||||
bodyKey: []string{"server going down"},
|
||||
})
|
||||
|
||||
msgs, _ = tserver.pollMessages(receiverToken, receiverLastID)
|
||||
if !findMessage(msgs, irc.CmdWallops, "walloper") {
|
||||
t.Errorf("expected WALLOPS for the +w user, got %v", msgs)
|
||||
}
|
||||
|
||||
msgs, _ = tserver.pollMessages(plainToken, plainLastID)
|
||||
if findMessage(msgs, irc.CmdWallops, "walloper") {
|
||||
t.Errorf("WALLOPS reached a user without +w: %v", msgs)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUserMode(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const (
|
||||
nick = "alice"
|
||||
other = "other"
|
||||
)
|
||||
|
||||
tserver := newTestServerWithOper(t)
|
||||
|
||||
token := tserver.createSession(nick)
|
||||
otherToken := tserver.createSession(other)
|
||||
operToken, operLastID := newOperSession(tserver, "deoper")
|
||||
|
||||
// mode sends MODE for target from token, with modeStr
|
||||
// unless it is empty, and returns the session's next
|
||||
// messages.
|
||||
mode := func(
|
||||
token string, lastID int64, target, modeStr string,
|
||||
) ([]map[string]any, int64) {
|
||||
cmd := map[string]any{commandKey: modeCmd, toKey: target}
|
||||
if modeStr != "" {
|
||||
cmd[bodyKey] = []string{modeStr}
|
||||
}
|
||||
|
||||
return sendAndPoll(tserver, token, lastID, cmd)
|
||||
}
|
||||
|
||||
_, otherLastID := mode(otherToken, 0, other, "+w")
|
||||
_, lastID := tserver.pollMessages(token, 0)
|
||||
|
||||
for _, check := range []struct {
|
||||
target, modeStr, numeric, modes string
|
||||
}{
|
||||
{nick, "+w", "221", "+w"},
|
||||
{"Alice", "", "502", ""},
|
||||
{"Alice", "-w", "502", ""},
|
||||
{nick, "", "221", "+w"},
|
||||
{nick, "-w", "221", "+"},
|
||||
{nick, "+z", "501", ""},
|
||||
{nick, "+o", "501", ""},
|
||||
{other, "", "502", ""},
|
||||
{other, "-w", "502", ""},
|
||||
} {
|
||||
var msgs []map[string]any
|
||||
|
||||
msgs, lastID = mode(token, lastID, check.target, check.modeStr)
|
||||
|
||||
if check.numeric != "221" {
|
||||
if !findNumeric(msgs, check.numeric) ||
|
||||
findNumeric(msgs, "221") {
|
||||
t.Errorf(
|
||||
"MODE %s %s: expected only %s, got %v",
|
||||
check.target, check.modeStr,
|
||||
check.numeric, msgs,
|
||||
)
|
||||
}
|
||||
|
||||
continue
|
||||
}
|
||||
|
||||
got := numericBody(t, msgs, "221")
|
||||
if got != check.modes {
|
||||
t.Errorf(
|
||||
"MODE %s %s: expected %q, got %q",
|
||||
check.target, check.modeStr, check.modes, got,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
msgs, _ := mode(otherToken, otherLastID, other, "")
|
||||
if got := numericBody(t, msgs, "221"); got != "+w" {
|
||||
t.Errorf("%s's modes changed to %q", other, got)
|
||||
}
|
||||
|
||||
msgs, _ = mode(operToken, operLastID, "deoper", "-o")
|
||||
if got := numericBody(t, msgs, "221"); got != "+" {
|
||||
t.Errorf("after -o: expected +, got %q", got)
|
||||
}
|
||||
}
|
||||
@@ -77,9 +77,13 @@ func NewValidator(resource string) *Validator {
|
||||
return validator
|
||||
}
|
||||
|
||||
// Validate checks a hashcash stamp. It returns nil if the
|
||||
// stamp is valid and has not been seen before.
|
||||
func (v *Validator) Validate(
|
||||
// Check returns nil if requiredBits is not positive, or if
|
||||
// the stamp is a well-formed, recently dated proof of work
|
||||
// for this resource with at least requiredBits. It does not
|
||||
// look at or change the set of spent stamps, so a request
|
||||
// can check its stamp first and Claim it after its other
|
||||
// checks.
|
||||
func (v *Validator) Check(
|
||||
stamp string,
|
||||
requiredBits int,
|
||||
) error {
|
||||
@@ -87,9 +91,49 @@ func (v *Validator) Validate(
|
||||
return nil
|
||||
}
|
||||
|
||||
_, err := v.check(stamp, requiredBits)
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
// Claim checks the stamp as Check does and, when
|
||||
// requiredBits is positive, records it as spent until it
|
||||
// expires. It returns an error if the stamp is already
|
||||
// spent. Release gives a claimed stamp back.
|
||||
func (v *Validator) Claim(
|
||||
stamp string,
|
||||
requiredBits int,
|
||||
) error {
|
||||
if requiredBits <= 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
stampTime, err := v.check(stamp, requiredBits)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return v.checkAndRecordStamp(stamp, stampTime)
|
||||
}
|
||||
|
||||
// Release forgets a claimed stamp so that it can be claimed
|
||||
// again, for a request that failed after its Claim.
|
||||
// Releasing a stamp that is not claimed does nothing.
|
||||
func (v *Validator) Release(stamp string) {
|
||||
v.mu.Lock()
|
||||
defer v.mu.Unlock()
|
||||
|
||||
delete(v.spent, stamp)
|
||||
}
|
||||
|
||||
// check returns the stamp's date if Check accepts it.
|
||||
func (v *Validator) check(
|
||||
stamp string,
|
||||
requiredBits int,
|
||||
) (time.Time, error) {
|
||||
parts := strings.Split(stamp, ":")
|
||||
if len(parts) != stampFields {
|
||||
return fmt.Errorf(
|
||||
return time.Time{}, fmt.Errorf(
|
||||
"%w: expected %d, got %d",
|
||||
errInvalidFields, stampFields, len(parts),
|
||||
)
|
||||
@@ -104,25 +148,25 @@ func (v *Validator) Validate(
|
||||
version, bitsStr, resource, requiredBits,
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
return time.Time{}, err
|
||||
}
|
||||
|
||||
stampTime, err := parseStampDate(dateStr)
|
||||
if err != nil {
|
||||
return err
|
||||
return time.Time{}, err
|
||||
}
|
||||
|
||||
err = validateTime(stampTime)
|
||||
if err != nil {
|
||||
return err
|
||||
return time.Time{}, err
|
||||
}
|
||||
|
||||
err = validateProof(stamp, requiredBits)
|
||||
if err != nil {
|
||||
return err
|
||||
return time.Time{}, err
|
||||
}
|
||||
|
||||
return v.checkAndRecordStamp(stamp, stampTime)
|
||||
return stampTime, nil
|
||||
}
|
||||
|
||||
func (v *Validator) validateHeader(
|
||||
|
||||
@@ -85,7 +85,7 @@ func TestMintAndValidate(t *testing.T) {
|
||||
t, testBits, "test-resource", todayDate(),
|
||||
)
|
||||
|
||||
err := validator.Validate(stamp, testBits)
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf("valid stamp rejected: %v", err)
|
||||
}
|
||||
@@ -99,17 +99,74 @@ func TestReplayDetection(t *testing.T) {
|
||||
t, testBits, "test-resource", todayDate(),
|
||||
)
|
||||
|
||||
err := validator.Validate(stamp, testBits)
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf("first use failed: %v", err)
|
||||
}
|
||||
|
||||
err = validator.Validate(stamp, testBits)
|
||||
err = validator.Claim(stamp, testBits)
|
||||
if err == nil {
|
||||
t.Fatal("replay not detected")
|
||||
}
|
||||
}
|
||||
|
||||
// TestCheckDoesNotSpendStamp checks that a stamp Check
|
||||
// accepts can still be claimed, and only once, and that
|
||||
// Check still accepts it once it is spent.
|
||||
func TestCheckDoesNotSpendStamp(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
validator := hashcash.NewValidator("test-resource")
|
||||
stamp := mintStampWithDate(
|
||||
t, testBits, "test-resource", todayDate(),
|
||||
)
|
||||
|
||||
for range 2 {
|
||||
err := validator.Check(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf("valid stamp rejected: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf("claim after check failed: %v", err)
|
||||
}
|
||||
|
||||
err = validator.Claim(stamp, testBits)
|
||||
if err == nil {
|
||||
t.Fatal("replay not detected")
|
||||
}
|
||||
|
||||
err = validator.Check(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf("spent stamp rejected by Check: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestReleasedStampCanBeClaimedAgain checks that Release
|
||||
// gives a claimed stamp back.
|
||||
func TestReleasedStampCanBeClaimedAgain(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
validator := hashcash.NewValidator("test-resource")
|
||||
stamp := mintStampWithDate(
|
||||
t, testBits, "test-resource", todayDate(),
|
||||
)
|
||||
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf("first claim failed: %v", err)
|
||||
}
|
||||
|
||||
validator.Release(stamp)
|
||||
|
||||
err = validator.Claim(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf("claim after release failed: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestResourceMismatch(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -118,7 +175,7 @@ func TestResourceMismatch(t *testing.T) {
|
||||
t, testBits, "wrong-resource", todayDate(),
|
||||
)
|
||||
|
||||
err := validator.Validate(stamp, testBits)
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err == nil {
|
||||
t.Fatal("expected resource mismatch error")
|
||||
}
|
||||
@@ -129,7 +186,7 @@ func TestInvalidStampFormat(t *testing.T) {
|
||||
|
||||
validator := hashcash.NewValidator("test-resource")
|
||||
|
||||
err := validator.Validate(
|
||||
err := validator.Claim(
|
||||
"not:a:valid:stamp", testBits,
|
||||
)
|
||||
if err == nil {
|
||||
@@ -146,7 +203,7 @@ func TestBadVersion(t *testing.T) {
|
||||
testBits, todayDate(), "test-resource",
|
||||
)
|
||||
|
||||
err := validator.Validate(stamp, testBits)
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err == nil {
|
||||
t.Fatal("expected bad version error")
|
||||
}
|
||||
@@ -162,7 +219,7 @@ func TestInsufficientDifficulty(t *testing.T) {
|
||||
todayDate(), "test-resource",
|
||||
)
|
||||
|
||||
err := validator.Validate(stamp, testBits)
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err == nil {
|
||||
t.Fatal("expected insufficient bits error")
|
||||
}
|
||||
@@ -178,7 +235,7 @@ func TestExpiredStamp(t *testing.T) {
|
||||
t, testBits, "test-resource", oldDate,
|
||||
)
|
||||
|
||||
err := validator.Validate(stamp, testBits)
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err == nil {
|
||||
t.Fatal("expected expired stamp error")
|
||||
}
|
||||
@@ -189,9 +246,14 @@ func TestZeroBitsSkipsValidation(t *testing.T) {
|
||||
|
||||
validator := hashcash.NewValidator("test-resource")
|
||||
|
||||
err := validator.Validate("garbage", 0)
|
||||
err := validator.Check("garbage", 0)
|
||||
if err != nil {
|
||||
t.Fatalf("zero bits should skip: %v", err)
|
||||
t.Fatalf("zero bits should skip the check: %v", err)
|
||||
}
|
||||
|
||||
err = validator.Claim("garbage", 0)
|
||||
if err != nil {
|
||||
t.Fatalf("zero bits should skip the claim: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -204,7 +266,7 @@ func TestLongDateFormat(t *testing.T) {
|
||||
t, testBits, "test-resource", longDate,
|
||||
)
|
||||
|
||||
err := validator.Validate(stamp, testBits)
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf("long date stamp rejected: %v", err)
|
||||
}
|
||||
@@ -219,7 +281,7 @@ func TestBadDateFormat(t *testing.T) {
|
||||
testBits, "test-resource",
|
||||
)
|
||||
|
||||
err := validator.Validate(stamp, testBits)
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err == nil {
|
||||
t.Fatal("expected bad date error")
|
||||
}
|
||||
@@ -235,7 +297,7 @@ func TestMultipleUniqueStamps(t *testing.T) {
|
||||
t, testBits, "test-resource", todayDate(),
|
||||
)
|
||||
|
||||
err := validator.Validate(stamp, testBits)
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf("unique stamp rejected: %v", err)
|
||||
}
|
||||
@@ -251,7 +313,7 @@ func TestHigherBitsStillValid(t *testing.T) {
|
||||
t, 4, "test-resource", todayDate(),
|
||||
)
|
||||
|
||||
err := validator.Validate(stamp, testBits)
|
||||
err := validator.Claim(stamp, testBits)
|
||||
if err != nil {
|
||||
t.Fatalf(
|
||||
"higher-difficulty stamp rejected: %v",
|
||||
|
||||
+206
-109
@@ -4,6 +4,7 @@ import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"slices"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
@@ -13,7 +14,7 @@ import (
|
||||
)
|
||||
|
||||
// sendIRCError maps a service.IRCError to an IRC numeric
|
||||
// reply on the wire.
|
||||
// reply on the wire, and logs any other error.
|
||||
func (c *Conn) sendIRCError(err error) {
|
||||
var ircErr *service.IRCError
|
||||
if errors.As(err, &ircErr) {
|
||||
@@ -21,7 +22,11 @@ func (c *Conn) sendIRCError(err error) {
|
||||
args = append(args, ircErr.Params...)
|
||||
args = append(args, ircErr.Message)
|
||||
c.sendNumeric(ircErr.Code, args...)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
c.log.Error("command failed", "error", err)
|
||||
}
|
||||
|
||||
// handleCAP silently acknowledges CAP negotiation.
|
||||
@@ -66,15 +71,20 @@ func (c *Conn) handleNick(
|
||||
}
|
||||
|
||||
newNick := msg.Params[0]
|
||||
if len(newNick) > maxNickLen {
|
||||
newNick = newNick[:maxNickLen]
|
||||
if !service.ValidNick(newNick) {
|
||||
c.sendNumeric(
|
||||
irc.ErrErroneusNickname,
|
||||
newNick, "Erroneous nickname",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
oldMask := c.hostmask()
|
||||
oldNick := c.nick
|
||||
oldNick := c.currentNick()
|
||||
|
||||
err := c.svc.ChangeNick(
|
||||
ctx, c.sessionID, oldNick, newNick,
|
||||
ctx, c.sessionID, c.clientID, oldNick, newNick,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
@@ -82,9 +92,10 @@ func (c *Conn) handleNick(
|
||||
return
|
||||
}
|
||||
|
||||
c.mu.Lock()
|
||||
c.nick = newNick
|
||||
c.mu.Unlock()
|
||||
// Take the nick the session holds, not newNick: another
|
||||
// client of the session may have changed it again since
|
||||
// ChangeNick stored newNick.
|
||||
c.loadSessionNick(ctx)
|
||||
|
||||
// Echo NICK change to the client on wire.
|
||||
c.send(FormatMessage(oldMask, "NICK", newNick))
|
||||
@@ -118,8 +129,8 @@ func (c *Conn) handlePrivmsg(
|
||||
body, _ := json.Marshal([]string{text}) //nolint:errchkjson
|
||||
|
||||
if strings.HasPrefix(target, "#") {
|
||||
_, _, err := c.svc.SendChannelMessage(
|
||||
ctx, c.sessionID, c.nick,
|
||||
_, err := c.svc.SendChannelMessage(
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(),
|
||||
msg.Command, target, body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
@@ -127,7 +138,7 @@ func (c *Conn) handlePrivmsg(
|
||||
}
|
||||
} else {
|
||||
result, err := c.svc.SendDirectMessage(
|
||||
ctx, c.sessionID, c.nick,
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(),
|
||||
msg.Command, target, body, nil,
|
||||
)
|
||||
if err != nil {
|
||||
@@ -145,7 +156,9 @@ func (c *Conn) handlePrivmsg(
|
||||
}
|
||||
|
||||
// handleJoin joins one or more channels via the shared
|
||||
// service layer.
|
||||
// service layer. The optional second parameter holds the
|
||||
// channel keys, comma-separated in the order of the
|
||||
// channels.
|
||||
func (c *Conn) handleJoin(
|
||||
ctx context.Context,
|
||||
msg *Message,
|
||||
@@ -159,14 +172,24 @@ func (c *Conn) handleJoin(
|
||||
return
|
||||
}
|
||||
|
||||
for chanName := range strings.SplitSeq(msg.Params[0], ",") {
|
||||
var keys []string
|
||||
if len(msg.Params) > 1 {
|
||||
keys = strings.Split(msg.Params[1], ",")
|
||||
}
|
||||
|
||||
for idx, chanName := range strings.Split(msg.Params[0], ",") {
|
||||
chanName = strings.TrimSpace(chanName)
|
||||
|
||||
if !strings.HasPrefix(chanName, "#") {
|
||||
chanName = "#" + chanName
|
||||
}
|
||||
|
||||
c.joinChannel(ctx, chanName)
|
||||
key := ""
|
||||
if idx < len(keys) {
|
||||
key = keys[idx]
|
||||
}
|
||||
|
||||
c.joinChannel(ctx, chanName, key)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -174,10 +197,10 @@ func (c *Conn) handleJoin(
|
||||
// and delivers topic/names on the wire.
|
||||
func (c *Conn) joinChannel(
|
||||
ctx context.Context,
|
||||
channel string,
|
||||
channel, key string,
|
||||
) {
|
||||
result, err := c.svc.JoinChannel(
|
||||
ctx, c.sessionID, c.nick, channel, "",
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(), channel, key,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
@@ -315,7 +338,7 @@ func (c *Conn) partChannel(
|
||||
channel, reason string,
|
||||
) {
|
||||
err := c.svc.PartChannel(
|
||||
ctx, c.sessionID, c.nick, channel, reason,
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(), channel, reason,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
@@ -345,7 +368,11 @@ func (c *Conn) handleQuit(msg *Message) {
|
||||
|
||||
c.send("ERROR :Closing Link: " + c.hostname +
|
||||
" (Quit: " + reason + ")")
|
||||
|
||||
c.mu.Lock()
|
||||
c.closed = true
|
||||
c.quitReason = reason
|
||||
c.mu.Unlock()
|
||||
}
|
||||
|
||||
// handleTopic gets or sets a channel topic via the shared
|
||||
@@ -376,7 +403,7 @@ func (c *Conn) handleTopic(
|
||||
newTopic := msg.Params[1]
|
||||
|
||||
err := c.svc.SetTopic(
|
||||
ctx, c.sessionID, c.nick, channel, newTopic,
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(), channel, newTopic,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
@@ -427,7 +454,7 @@ func (c *Conn) handleMode(
|
||||
if strings.HasPrefix(target, "#") {
|
||||
c.handleChannelMode(ctx, msg)
|
||||
} else {
|
||||
c.handleUserMode(msg)
|
||||
c.handleUserMode(ctx, msg)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -676,21 +703,26 @@ func (c *Conn) applyChannelModes(
|
||||
if applied.Len() > 0 {
|
||||
modeReply := applied.String() + appliedArgs.String()
|
||||
|
||||
c.send(FormatMessage(
|
||||
c.hostmask(), "MODE", channel, modeReply,
|
||||
))
|
||||
params := slices.Concat(
|
||||
[]string{channel}, strings.Fields(modeReply),
|
||||
)
|
||||
|
||||
c.send(FormatMessage(c.hostmask(), "MODE", params...))
|
||||
|
||||
c.svc.BroadcastMode(
|
||||
ctx, c.nick, channel, chID, modeReply,
|
||||
ctx, c.clientID, c.currentNick(), channel, chID, modeReply,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// handleUserMode handles MODE for users.
|
||||
func (c *Conn) handleUserMode(msg *Message) {
|
||||
target := msg.Params[0]
|
||||
|
||||
if !strings.EqualFold(target, c.nick) {
|
||||
// handleUserMode handles MODE for a nick: a query without a
|
||||
// mode string, otherwise a change. Only the client's own
|
||||
// nick is allowed.
|
||||
func (c *Conn) handleUserMode(
|
||||
ctx context.Context,
|
||||
msg *Message,
|
||||
) {
|
||||
if msg.Params[0] != c.currentNick() {
|
||||
c.sendNumeric(
|
||||
irc.ErrUsersDoNotMatch,
|
||||
"Can't change mode for other users",
|
||||
@@ -699,8 +731,26 @@ func (c *Conn) handleUserMode(msg *Message) {
|
||||
return
|
||||
}
|
||||
|
||||
// We don't support user modes beyond the basics.
|
||||
c.sendNumeric(irc.RplUmodeIs, "+")
|
||||
var (
|
||||
modes string
|
||||
err error
|
||||
)
|
||||
|
||||
if len(msg.Params) == 1 {
|
||||
modes, err = c.svc.QueryUserMode(ctx, c.sessionID)
|
||||
} else {
|
||||
modes, err = c.svc.ApplyUserMode(
|
||||
ctx, c.sessionID, msg.Params[1],
|
||||
)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
c.sendNumeric(irc.RplUmodeIs, modes)
|
||||
}
|
||||
|
||||
// handleNames replies with channel member list.
|
||||
@@ -732,10 +782,11 @@ func (c *Conn) handleNames(
|
||||
c.deliverNames(ctx, channel, chID)
|
||||
}
|
||||
|
||||
// handleList sends the channel list.
|
||||
// handleList sends the channel list, leaving out +s
|
||||
// channels the user is not on.
|
||||
func (c *Conn) handleList(ctx context.Context) {
|
||||
channels, err := c.database.ListAllChannelsWithCounts(
|
||||
ctx,
|
||||
channels, err := c.database.ListAllChannelsWithCountsFiltered(
|
||||
ctx, c.sessionID,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendNumeric(
|
||||
@@ -855,14 +906,15 @@ func (c *Conn) whoisOper(
|
||||
}
|
||||
}
|
||||
|
||||
// whoisChannels sends 319 RPL_WHOISCHANNELS.
|
||||
// whoisChannels sends 319 RPL_WHOISCHANNELS, leaving out
|
||||
// +s channels the querier is not on.
|
||||
func (c *Conn) whoisChannels(
|
||||
ctx context.Context,
|
||||
target string,
|
||||
targetID int64,
|
||||
) {
|
||||
userChannels, _ := c.database.GetSessionChannels(
|
||||
ctx, targetID,
|
||||
userChannels, _ := c.database.GetSessionChannelsFiltered(
|
||||
ctx, targetID, c.sessionID,
|
||||
)
|
||||
if len(userChannels) == 0 {
|
||||
return
|
||||
@@ -1135,7 +1187,7 @@ func (c *Conn) handleKick(
|
||||
}
|
||||
|
||||
err := c.svc.KickUser(
|
||||
ctx, c.sessionID, c.nick,
|
||||
ctx, c.sessionID, c.clientID, c.currentNick(),
|
||||
channel, targetNick, reason,
|
||||
)
|
||||
if err != nil {
|
||||
@@ -1166,19 +1218,21 @@ func (c *Conn) handlePassPostReg(
|
||||
}
|
||||
|
||||
password := msg.Params[0]
|
||||
if len(password) < minPasswordLen {
|
||||
c.sendFromServer("NOTICE", c.nick,
|
||||
"Password must be at least 8 characters",
|
||||
)
|
||||
|
||||
if !c.checkPasswordLength(password) {
|
||||
return
|
||||
}
|
||||
|
||||
c.setPassword(ctx, password)
|
||||
err := c.setPassword(ctx, password)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
c.sendFromServer("NOTICE", c.nick,
|
||||
"Password set. You can reconnect using "+
|
||||
"PASS <password> with your nick.",
|
||||
// The IRC listener cannot add a connection to an existing
|
||||
// session; only the HTTP API login can.
|
||||
c.sendFromServer("NOTICE", c.currentNick(),
|
||||
"Password set. Another client can log in to this "+
|
||||
"session over the HTTP API: POST /api/v1/login "+
|
||||
"with your nick and this password.",
|
||||
)
|
||||
}
|
||||
|
||||
@@ -1199,36 +1253,11 @@ func (c *Conn) handleInvite(
|
||||
targetNick := msg.Params[0]
|
||||
channel := msg.Params[1]
|
||||
|
||||
chID, err := c.database.GetChannelByName(ctx, channel)
|
||||
if err != nil {
|
||||
c.sendNumeric(
|
||||
irc.ErrNoSuchChannel,
|
||||
channel, "No such channel",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
isMember, _ := c.database.IsChannelMember(
|
||||
ctx, chID, c.sessionID,
|
||||
)
|
||||
if !isMember {
|
||||
c.sendNumeric(
|
||||
irc.ErrNotOnChannel,
|
||||
channel, "You're not on that channel",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
targetID, err := c.database.GetSessionByNick(
|
||||
ctx, targetNick,
|
||||
targetID, err := c.svc.InviteUser(
|
||||
ctx, c.sessionID, c.currentNick(), targetNick, channel,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendNumeric(
|
||||
irc.ErrNoSuchNick,
|
||||
targetNick, "No such nick",
|
||||
)
|
||||
c.sendIRCError(err)
|
||||
|
||||
return
|
||||
}
|
||||
@@ -1237,58 +1266,126 @@ func (c *Conn) handleInvite(
|
||||
irc.RplInviting, targetNick, channel,
|
||||
)
|
||||
|
||||
// Send INVITE notice to target via service fan-out.
|
||||
body, _ := json.Marshal( //nolint:errchkjson
|
||||
[]string{"You have been invited to " + channel},
|
||||
)
|
||||
// Queue the INVITE to the target with the body the HTTP
|
||||
// API uses.
|
||||
body, _ := json.Marshal([]string{channel}) //nolint:errchkjson
|
||||
|
||||
_, _, _ = c.svc.FanOut( //nolint:dogsled // fire-and-forget broadcast
|
||||
ctx, "INVITE", c.nick, targetNick,
|
||||
nil, body, nil, []int64{targetID},
|
||||
ctx, "INVITE", c.currentNick(), targetNick, targetID, 0,
|
||||
nil, body, nil, []int64{targetID}, 0,
|
||||
)
|
||||
}
|
||||
|
||||
// handleUserhost replies with USERHOST info.
|
||||
// handleUserhost replies with user@host for each of up to
|
||||
// five nicks.
|
||||
func (c *Conn) handleUserhost(
|
||||
ctx context.Context,
|
||||
msg *Message,
|
||||
) {
|
||||
if len(msg.Params) < 1 {
|
||||
c.sendNumeric(
|
||||
irc.ErrNeedMoreParams,
|
||||
irc.CmdUserhost, "Not enough parameters",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
replies := make([]string, 0, len(msg.Params))
|
||||
|
||||
for _, nick := range msg.Params {
|
||||
sid, err := c.database.GetSessionByNick(ctx, nick)
|
||||
reply, err := c.svc.UserhostReply(
|
||||
ctx, msg.Params, c.serverSfx,
|
||||
)
|
||||
if err != nil {
|
||||
continue
|
||||
c.sendIRCError(err)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
hostInfo, _ := c.database.GetSessionHostInfo(
|
||||
ctx, sid,
|
||||
)
|
||||
|
||||
host := "*"
|
||||
if hostInfo != nil {
|
||||
host = hostInfo.Hostname
|
||||
}
|
||||
|
||||
isOper, _ := c.database.IsSessionOper(ctx, sid)
|
||||
|
||||
operStar := ""
|
||||
if isOper {
|
||||
operStar = "*"
|
||||
}
|
||||
|
||||
replies = append(
|
||||
replies,
|
||||
nick+operStar+"=+"+nick+"@"+host,
|
||||
)
|
||||
}
|
||||
c.sendNumeric(irc.RplUserHost, reply)
|
||||
}
|
||||
|
||||
// handleVersion replies with the server version.
|
||||
func (c *Conn) handleVersion() {
|
||||
c.sendNumeric(
|
||||
irc.RplUserHost,
|
||||
strings.Join(replies, " "),
|
||||
irc.RplVersion,
|
||||
c.svc.ServerVersion()+".", c.serverSfx, "",
|
||||
)
|
||||
}
|
||||
|
||||
// handleAdmin replies with the server's admin info.
|
||||
func (c *Conn) handleAdmin() {
|
||||
location1, location2, email := c.svc.AdminLines(c.serverSfx)
|
||||
|
||||
c.sendNumeric(
|
||||
irc.RplAdminMe, c.serverSfx, "Administrative info",
|
||||
)
|
||||
c.sendNumeric(irc.RplAdminLoc1, location1)
|
||||
c.sendNumeric(irc.RplAdminLoc2, location2)
|
||||
c.sendNumeric(irc.RplAdminEmail, email)
|
||||
}
|
||||
|
||||
// handleInfo replies with the server's software info.
|
||||
func (c *Conn) handleInfo() {
|
||||
for _, line := range c.svc.InfoLines() {
|
||||
c.sendNumeric(irc.RplInfo, line)
|
||||
}
|
||||
|
||||
c.sendNumeric(irc.RplEndOfInfo, "End of /INFO list")
|
||||
}
|
||||
|
||||
// handleTime replies with the server's local time.
|
||||
func (c *Conn) handleTime() {
|
||||
c.sendNumeric(
|
||||
irc.RplTime,
|
||||
c.serverSfx, time.Now().Format(time.RFC1123),
|
||||
)
|
||||
}
|
||||
|
||||
// handleKill handles KILL <nick> [<reason>].
|
||||
func (c *Conn) handleKill(
|
||||
ctx context.Context,
|
||||
msg *Message,
|
||||
) {
|
||||
if len(msg.Params) < 1 {
|
||||
c.sendNumeric(
|
||||
irc.ErrNeedMoreParams,
|
||||
irc.CmdKill, "Not enough parameters",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
reason := ""
|
||||
if len(msg.Params) > 1 {
|
||||
reason = msg.Params[1]
|
||||
}
|
||||
|
||||
err := c.svc.KillUser(
|
||||
ctx, c.sessionID, c.currentNick(),
|
||||
msg.Params[0], reason,
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
}
|
||||
}
|
||||
|
||||
// handleWallops handles WALLOPS <message>.
|
||||
func (c *Conn) handleWallops(
|
||||
ctx context.Context,
|
||||
msg *Message,
|
||||
) {
|
||||
if len(msg.Params) < 1 {
|
||||
c.sendNumeric(
|
||||
irc.ErrNeedMoreParams,
|
||||
irc.CmdWallops, "Not enough parameters",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
err := c.svc.SendWallops(
|
||||
ctx, c.sessionID, c.currentNick(), msg.Params[0],
|
||||
)
|
||||
if err != nil {
|
||||
c.sendIRCError(err)
|
||||
}
|
||||
}
|
||||
|
||||
+229
-28
@@ -20,14 +20,14 @@ import (
|
||||
|
||||
const (
|
||||
maxLineLen = 512
|
||||
readTimeout = 5 * time.Minute
|
||||
writeTimeout = 30 * time.Second
|
||||
killWriteWindow = 2 * time.Second
|
||||
dnsTimeout = 3 * time.Second
|
||||
pollInterval = 100 * time.Millisecond
|
||||
pingInterval = 90 * time.Second
|
||||
pongDeadline = 30 * time.Second
|
||||
maxNickLen = 32
|
||||
minPasswordLen = 8
|
||||
maxPasswordLen = 72 // bcrypt cannot hash a longer one
|
||||
maxHashcashBits = 40
|
||||
)
|
||||
|
||||
@@ -46,6 +46,11 @@ type Conn struct {
|
||||
serverSfx string
|
||||
commands map[string]cmdHandler
|
||||
|
||||
// writeMu serializes writes to conn, which come from
|
||||
// serve(), from the relay goroutine and, for KILL, from
|
||||
// Disconnect.
|
||||
writeMu sync.Mutex
|
||||
|
||||
mu sync.Mutex
|
||||
nick string
|
||||
username string
|
||||
@@ -58,14 +63,20 @@ type Conn struct {
|
||||
registered bool
|
||||
gotNick bool
|
||||
gotUser bool
|
||||
gotPass bool
|
||||
passWord string
|
||||
|
||||
lastQueueID int64
|
||||
closed bool
|
||||
killed bool
|
||||
|
||||
// quitReason is the reason in the QUIT that peers are
|
||||
// sent when the connection ends. The client's QUIT
|
||||
// replaces it.
|
||||
quitReason string
|
||||
}
|
||||
|
||||
func newConn(
|
||||
ctx context.Context,
|
||||
tcpConn net.Conn,
|
||||
log *slog.Logger,
|
||||
database *db.Database,
|
||||
@@ -89,7 +100,7 @@ func newConn(
|
||||
svc: svc,
|
||||
serverSfx: srvName,
|
||||
remoteIP: host,
|
||||
hostname: resolveHost(ctx, host),
|
||||
quitReason: "Connection closed",
|
||||
}
|
||||
|
||||
conn.commands = conn.buildCommandMap()
|
||||
@@ -97,6 +108,57 @@ func newConn(
|
||||
return conn
|
||||
}
|
||||
|
||||
// Disconnect ends the connection for an operator KILL from
|
||||
// either transport: the victim is sent KILL and ERROR, then
|
||||
// its socket is closed, which ends serve() and with it the
|
||||
// relay goroutine. It is called from the killer's goroutine
|
||||
// and does not wait for the writes, so a victim that has
|
||||
// stopped reading cannot stall the killer.
|
||||
func (c *Conn) Disconnect(reason string) {
|
||||
c.mu.Lock()
|
||||
|
||||
if c.closed {
|
||||
c.mu.Unlock()
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
c.closed = true
|
||||
c.killed = true
|
||||
nick := c.nick
|
||||
host := c.hostname
|
||||
c.mu.Unlock()
|
||||
|
||||
if nick == "" {
|
||||
nick = "*"
|
||||
}
|
||||
|
||||
go func() {
|
||||
c.notifyKilledAndClose(nick, host, reason)
|
||||
}()
|
||||
}
|
||||
|
||||
// notifyKilledAndClose sends a killed victim the KILL and
|
||||
// ERROR lines, each bounded by killWriteWindow, and then
|
||||
// closes its socket.
|
||||
func (c *Conn) notifyKilledAndClose(
|
||||
nick, host, reason string,
|
||||
) {
|
||||
defer func() { _ = c.conn.Close() }()
|
||||
|
||||
c.sendWithin(
|
||||
killWriteWindow,
|
||||
FormatMessage(
|
||||
c.serverSfx, irc.CmdKill, nick, reason,
|
||||
),
|
||||
)
|
||||
c.sendWithin(
|
||||
killWriteWindow,
|
||||
"ERROR :Closing Link: "+host+
|
||||
" ("+reason+")",
|
||||
)
|
||||
}
|
||||
|
||||
// buildCommandMap returns a map from IRC command strings
|
||||
// to handler functions.
|
||||
func (c *Conn) buildCommandMap() map[string]cmdHandler {
|
||||
@@ -129,7 +191,13 @@ func (c *Conn) buildCommandMap() map[string]cmdHandler {
|
||||
"CAP": func(_ context.Context, msg *Message) {
|
||||
c.handleCAP(msg)
|
||||
},
|
||||
"USERHOST": c.handleUserhost,
|
||||
irc.CmdUserhost: c.handleUserhost,
|
||||
irc.CmdVersion: func(context.Context, *Message) { c.handleVersion() },
|
||||
irc.CmdAdmin: func(context.Context, *Message) { c.handleAdmin() },
|
||||
irc.CmdInfo: func(context.Context, *Message) { c.handleInfo() },
|
||||
irc.CmdTime: func(context.Context, *Message) { c.handleTime() },
|
||||
irc.CmdKill: c.handleKill,
|
||||
irc.CmdWallops: c.handleWallops,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -150,18 +218,42 @@ func resolveHost(ctx context.Context, addr string) string {
|
||||
}
|
||||
|
||||
// serve is the main loop for a single IRC client connection.
|
||||
// It first sets the client's hostname to what resolve returns
|
||||
// for the client's address.
|
||||
// Cancelling ctx when it returns stops the relay goroutine.
|
||||
func (c *Conn) serve(ctx context.Context) {
|
||||
// When nothing has been read for interval the client is sent
|
||||
// a PING, and when nothing is read within deadline after that
|
||||
// the connection is closed.
|
||||
func (c *Conn) serve(
|
||||
ctx context.Context,
|
||||
resolve func(ctx context.Context, addr string) string,
|
||||
interval, deadline time.Duration,
|
||||
) {
|
||||
ctx, cancel := context.WithCancel(ctx)
|
||||
defer cancel()
|
||||
defer c.cleanup(ctx)
|
||||
// Stopping the server cancels ctx, and the cleanup must
|
||||
// still end the session then.
|
||||
defer c.cleanup(context.WithoutCancel(ctx))
|
||||
|
||||
// The hostname is looked up here, on this connection's
|
||||
// goroutine, and not when the connection is accepted, so
|
||||
// that a slow lookup holds up only this client.
|
||||
c.hostname = resolve(ctx, c.remoteIP)
|
||||
|
||||
ping := time.AfterFunc(interval, func() {
|
||||
c.send("PING :" + c.serverSfx)
|
||||
})
|
||||
defer ping.Stop()
|
||||
|
||||
scanner := bufio.NewScanner(c.conn)
|
||||
scanner.Buffer(make([]byte, maxLineLen), maxLineLen)
|
||||
|
||||
for {
|
||||
// Every line read starts both waits again.
|
||||
ping.Reset(interval)
|
||||
|
||||
_ = c.conn.SetReadDeadline(
|
||||
time.Now().Add(readTimeout),
|
||||
time.Now().Add(interval + deadline),
|
||||
)
|
||||
|
||||
if !scanner.Scan() {
|
||||
@@ -180,7 +272,7 @@ func (c *Conn) serve(ctx context.Context) {
|
||||
|
||||
c.handleMessage(ctx, msg)
|
||||
|
||||
if c.closed {
|
||||
if c.isClosed() {
|
||||
return
|
||||
}
|
||||
}
|
||||
@@ -189,24 +281,81 @@ func (c *Conn) serve(ctx context.Context) {
|
||||
func (c *Conn) cleanup(ctx context.Context) {
|
||||
c.mu.Lock()
|
||||
wasRegistered := c.registered
|
||||
wasKilled := c.killed
|
||||
sessID := c.sessionID
|
||||
nick := c.nick
|
||||
quitReason := c.quitReason
|
||||
c.closed = true
|
||||
c.mu.Unlock()
|
||||
|
||||
if wasRegistered && sessID > 0 {
|
||||
c.svc.BroadcastQuit(
|
||||
ctx, sessID, nick, "Connection closed",
|
||||
)
|
||||
c.svc.UnregisterWireConn(sessID, c)
|
||||
|
||||
// KILL has already sent the QUIT and deleted the
|
||||
// session.
|
||||
if !wasKilled {
|
||||
c.svc.BroadcastQuit(ctx, sessID, nick, quitReason)
|
||||
}
|
||||
}
|
||||
|
||||
c.conn.Close() //nolint:errcheck,gosec
|
||||
}
|
||||
|
||||
// isClosed reports whether QUIT or KILL has ended the
|
||||
// connection.
|
||||
func (c *Conn) isClosed() bool {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
|
||||
return c.closed
|
||||
}
|
||||
|
||||
// currentNick returns c.nick, read under c.mu.
|
||||
func (c *Conn) currentNick() string {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
|
||||
return c.nick
|
||||
}
|
||||
|
||||
// loadSessionNick sets c.nick to the nick the connection's
|
||||
// session holds in the database, read by session ID. The
|
||||
// connection's own NICK and the relay passing on a NICK line
|
||||
// both call it, and it reads and sets the nick under c.mu, so
|
||||
// whichever runs last leaves the connection on its session's
|
||||
// nick. If the read fails, c.nick is left as it is.
|
||||
func (c *Conn) loadSessionNick(ctx context.Context) {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
|
||||
nick, err := c.database.GetSessionNick(ctx, c.sessionID)
|
||||
if err == nil {
|
||||
c.nick = nick
|
||||
}
|
||||
}
|
||||
|
||||
// send writes a formatted IRC line to the connection.
|
||||
func (c *Conn) send(line string) {
|
||||
c.sendWithin(writeTimeout, line)
|
||||
}
|
||||
|
||||
// sendWithin writes a formatted IRC line to the connection,
|
||||
// giving up after timeout. CR, LF and NUL are removed first,
|
||||
// as FormatMessage does for each parameter, so that a line
|
||||
// built without it cannot end early either.
|
||||
func (c *Conn) sendWithin(
|
||||
timeout time.Duration,
|
||||
line string,
|
||||
) {
|
||||
line = strings.ReplaceAll(line, "\r", "")
|
||||
line = strings.ReplaceAll(line, "\n", "")
|
||||
line = strings.ReplaceAll(line, "\x00", "")
|
||||
|
||||
c.writeMu.Lock()
|
||||
defer c.writeMu.Unlock()
|
||||
|
||||
_ = c.conn.SetWriteDeadline(
|
||||
time.Now().Add(writeTimeout),
|
||||
time.Now().Add(timeout),
|
||||
)
|
||||
|
||||
_, _ = fmt.Fprintf(c.conn, "%s\r\n", line)
|
||||
@@ -217,7 +366,7 @@ func (c *Conn) sendNumeric(
|
||||
code irc.IRCMessageType,
|
||||
params ...string,
|
||||
) {
|
||||
nick := c.nick
|
||||
nick := c.currentNick()
|
||||
if nick == "" {
|
||||
nick = "*"
|
||||
}
|
||||
@@ -241,9 +390,11 @@ func (c *Conn) sendFromServer(
|
||||
// hostmask returns the client's full hostmask
|
||||
// (nick!user@host).
|
||||
func (c *Conn) hostmask() string {
|
||||
nick := c.currentNick()
|
||||
|
||||
user := c.username
|
||||
if user == "" {
|
||||
user = c.nick
|
||||
user = nick
|
||||
}
|
||||
|
||||
host := c.hostname
|
||||
@@ -251,7 +402,7 @@ func (c *Conn) hostmask() string {
|
||||
host = c.remoteIP
|
||||
}
|
||||
|
||||
return c.nick + "!" + user + "@" + host
|
||||
return nick + "!" + user + "@" + host
|
||||
}
|
||||
|
||||
// handleMessage dispatches a parsed IRC message using
|
||||
@@ -261,13 +412,24 @@ func (c *Conn) handleMessage(
|
||||
msg *Message,
|
||||
) {
|
||||
// Before registration, only NICK, USER, PASS, PING,
|
||||
// QUIT, and CAP are accepted.
|
||||
// PONG, QUIT, and CAP are accepted.
|
||||
if !c.registered {
|
||||
c.handlePreRegistration(ctx, msg)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// Every command is activity, so the idle cleanup must not
|
||||
// remove this user.
|
||||
err := c.database.UpdateLastSeen(
|
||||
ctx, c.sessionID, c.clientID,
|
||||
)
|
||||
if err != nil {
|
||||
c.log.Error(
|
||||
"failed to update last_seen", "error", err,
|
||||
)
|
||||
}
|
||||
|
||||
handler, ok := c.commands[msg.Command]
|
||||
if !ok {
|
||||
c.sendNumeric(
|
||||
@@ -299,6 +461,7 @@ func (c *Conn) handlePreRegistration(
|
||||
}
|
||||
|
||||
c.passWord = msg.Params[0]
|
||||
c.gotPass = true
|
||||
case irc.CmdNick:
|
||||
if len(msg.Params) < 1 {
|
||||
c.sendNumeric(
|
||||
@@ -309,11 +472,16 @@ func (c *Conn) handlePreRegistration(
|
||||
return
|
||||
}
|
||||
|
||||
c.nick = msg.Params[0]
|
||||
if len(c.nick) > maxNickLen {
|
||||
c.nick = c.nick[:maxNickLen]
|
||||
if !service.ValidNick(msg.Params[0]) {
|
||||
c.sendNumeric(
|
||||
irc.ErrErroneusNickname,
|
||||
msg.Params[0], "Erroneous nickname",
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
c.nick = msg.Params[0]
|
||||
c.gotNick = true
|
||||
case irc.CmdUser:
|
||||
if len(msg.Params) < 4 { //nolint:mnd
|
||||
@@ -331,6 +499,10 @@ func (c *Conn) handlePreRegistration(
|
||||
case irc.CmdPing:
|
||||
c.handlePing(msg)
|
||||
|
||||
return
|
||||
case irc.CmdPong:
|
||||
// The answer to serve's PING, which unregistered
|
||||
// clients are sent too.
|
||||
return
|
||||
case irc.CmdQuit:
|
||||
c.handleQuit(msg)
|
||||
@@ -387,7 +559,10 @@ func (c *Conn) completeRegistration(ctx context.Context) {
|
||||
"failed to create session", "error", err,
|
||||
)
|
||||
c.send("ERROR :Internal server error")
|
||||
|
||||
c.mu.Lock()
|
||||
c.closed = true
|
||||
c.mu.Unlock()
|
||||
|
||||
return
|
||||
}
|
||||
@@ -398,17 +573,23 @@ func (c *Conn) completeRegistration(ctx context.Context) {
|
||||
c.registered = true
|
||||
c.mu.Unlock()
|
||||
|
||||
// If PASS was provided before registration, set the
|
||||
// session password.
|
||||
if c.passWord != "" && len(c.passWord) >= minPasswordLen {
|
||||
c.setPassword(ctx, c.passWord)
|
||||
}
|
||||
// So that KILL, from either transport, can close it.
|
||||
c.svc.RegisterWireConn(sessionID, c)
|
||||
|
||||
// Send welcome burst.
|
||||
c.deliverWelcome()
|
||||
c.deliverLusers(ctx)
|
||||
c.deliverMOTD()
|
||||
|
||||
// If PASS was given before registration, store its
|
||||
// password now, after the welcome burst, so that a
|
||||
// NOTICE refusing it reaches a registered client. A
|
||||
// failure to store it is only logged, as it is for PASS
|
||||
// after registration.
|
||||
if c.gotPass && c.checkPasswordLength(c.passWord) {
|
||||
_ = c.setPassword(ctx, c.passWord)
|
||||
}
|
||||
|
||||
// Start the message relay goroutine.
|
||||
go c.relayMessages(ctx)
|
||||
}
|
||||
@@ -429,7 +610,7 @@ func (c *Conn) deliverWelcome() {
|
||||
)
|
||||
c.sendNumeric(
|
||||
irc.RplMyInfo,
|
||||
c.serverSfx, "neoirc", "", "mnst",
|
||||
c.serverSfx, "neoirc", service.UserModes, "Himnostv",
|
||||
)
|
||||
c.sendNumeric(
|
||||
irc.RplIsupport,
|
||||
@@ -491,13 +672,33 @@ func (c *Conn) deliverMOTD() {
|
||||
)
|
||||
}
|
||||
|
||||
// setPassword sets a bcrypt password on the session.
|
||||
func (c *Conn) setPassword(ctx context.Context, pw string) {
|
||||
// checkPasswordLength reports whether pw is 8 to 72 bytes
|
||||
// long, and sends the client a NOTICE saying so when it is
|
||||
// not.
|
||||
func (c *Conn) checkPasswordLength(pw string) bool {
|
||||
if len(pw) >= minPasswordLen && len(pw) <= maxPasswordLen {
|
||||
return true
|
||||
}
|
||||
|
||||
c.sendFromServer("NOTICE", c.currentNick(),
|
||||
"Password must be 8 to 72 bytes",
|
||||
)
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
// setPassword sets a bcrypt password on the session, and
|
||||
// logs and returns the error when it was not stored.
|
||||
func (c *Conn) setPassword(ctx context.Context, pw string) error {
|
||||
// Use the database's auth module to hash and store.
|
||||
err := c.database.SetPassword(ctx, c.sessionID, pw)
|
||||
if err != nil {
|
||||
c.log.Error(
|
||||
"failed to set password", "error", err,
|
||||
)
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -0,0 +1,148 @@
|
||||
package ircserver_test
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"log/slog"
|
||||
"net"
|
||||
"os"
|
||||
"slices"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/config"
|
||||
"sneak.berlin/go/neoirc/internal/ircserver"
|
||||
)
|
||||
|
||||
// newKillVictim returns a Conn for the nick victim whose
|
||||
// socket is one end of a net.Pipe, and the other end, from
|
||||
// which the test reads what the victim is sent. A write to
|
||||
// the pipe blocks until the other end reads.
|
||||
func newKillVictim(t *testing.T) (*ircserver.Conn, net.Conn) {
|
||||
t.Helper()
|
||||
|
||||
serverSide, clientSide := net.Pipe()
|
||||
|
||||
t.Cleanup(func() { _ = clientSide.Close() })
|
||||
|
||||
log := slog.New(slog.NewTextHandler(
|
||||
os.Stderr,
|
||||
&slog.HandlerOptions{Level: slog.LevelError},
|
||||
))
|
||||
cfg := &config.Config{ServerName: testServerName}
|
||||
|
||||
return ircserver.NewTestConn(
|
||||
log, cfg, serverSide, "victim",
|
||||
), clientSide
|
||||
}
|
||||
|
||||
// TestDisconnectDoesNotBlockOnUnresponsiveVictim checks
|
||||
// that Disconnect returns although the victim never reads,
|
||||
// so a KILL cannot stall the operator who sent it. The
|
||||
// limit is well below one KillWriteWindow, so a Disconnect
|
||||
// that waits on any write to the victim fails.
|
||||
func TestDisconnectDoesNotBlockOnUnresponsiveVictim(
|
||||
t *testing.T,
|
||||
) {
|
||||
t.Parallel()
|
||||
|
||||
victim, _ := newKillVictim(t)
|
||||
returned := make(chan struct{})
|
||||
|
||||
go func() {
|
||||
victim.Disconnect("killed by oper")
|
||||
close(returned)
|
||||
}()
|
||||
|
||||
select {
|
||||
case <-returned:
|
||||
case <-time.After(ircserver.KillWriteWindow / 4):
|
||||
t.Fatal("Disconnect waited for the victim to read")
|
||||
}
|
||||
}
|
||||
|
||||
// TestDisconnectNotifiesAndClosesVictim checks that a
|
||||
// victim that reads is sent KILL and ERROR, and that its
|
||||
// connection is then closed.
|
||||
func TestDisconnectNotifiesAndClosesVictim(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
victim, clientSide := newKillVictim(t)
|
||||
received := make(chan []string, 1)
|
||||
|
||||
go func() {
|
||||
var lines []string
|
||||
|
||||
scanner := bufio.NewScanner(clientSide)
|
||||
for scanner.Scan() {
|
||||
lines = append(lines, scanner.Text())
|
||||
}
|
||||
|
||||
received <- lines
|
||||
}()
|
||||
|
||||
victim.Disconnect("killed by oper")
|
||||
|
||||
var lines []string
|
||||
|
||||
select {
|
||||
case lines = <-received:
|
||||
case <-time.After(testTimeout):
|
||||
t.Fatal("the victim's connection was not closed")
|
||||
}
|
||||
|
||||
joined := strings.Join(lines, "\n")
|
||||
|
||||
if !strings.Contains(joined, "KILL victim :killed by oper") {
|
||||
t.Errorf("missing KILL line, got: %q", joined)
|
||||
}
|
||||
|
||||
if !strings.Contains(joined, "ERROR :Closing Link:") {
|
||||
t.Errorf("missing ERROR line, got: %q", joined)
|
||||
}
|
||||
}
|
||||
|
||||
// TestDisconnectReasonCannotStartLine checks that CR, LF and
|
||||
// NUL in a KILL reason are removed from both the KILL line
|
||||
// and the ERROR line, so the victim gets exactly those two
|
||||
// lines. The ERROR line is not built with FormatMessage, so
|
||||
// only the removal in sendWithin protects it.
|
||||
func TestDisconnectReasonCannotStartLine(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
victim, clientSide := newKillVictim(t)
|
||||
received := make(chan []string, 1)
|
||||
|
||||
go func() {
|
||||
var lines []string
|
||||
|
||||
scanner := bufio.NewScanner(clientSide)
|
||||
for scanner.Scan() {
|
||||
lines = append(lines, scanner.Text())
|
||||
}
|
||||
|
||||
received <- lines
|
||||
}()
|
||||
|
||||
victim.Disconnect("bye\r\nPRIVMSG victim :forged\x00")
|
||||
|
||||
var lines []string
|
||||
|
||||
select {
|
||||
case lines = <-received:
|
||||
case <-time.After(testTimeout):
|
||||
t.Fatal("the victim's connection was not closed")
|
||||
}
|
||||
|
||||
// The test connection has no host name, hence the two
|
||||
// spaces after "Closing Link:".
|
||||
want := []string{
|
||||
":" + testServerName +
|
||||
" KILL victim :byePRIVMSG victim :forged",
|
||||
"ERROR :Closing Link: (byePRIVMSG victim :forged)",
|
||||
}
|
||||
|
||||
if !slices.Equal(lines, want) {
|
||||
t.Errorf("got lines %q, want %q", lines, want)
|
||||
}
|
||||
}
|
||||
@@ -4,23 +4,36 @@ import (
|
||||
"context"
|
||||
"log/slog"
|
||||
"net"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/broker"
|
||||
"sneak.berlin/go/neoirc/internal/config"
|
||||
"sneak.berlin/go/neoirc/internal/db"
|
||||
"sneak.berlin/go/neoirc/internal/globals"
|
||||
"sneak.berlin/go/neoirc/internal/service"
|
||||
)
|
||||
|
||||
// NewTestServer creates a Server suitable for testing.
|
||||
// NewTestServer creates a Server suitable for testing, whose
|
||||
// connections use interval and deadline in place of
|
||||
// pingInterval and pongDeadline, and resolve in place of
|
||||
// resolveHost.
|
||||
// The caller must call Stop() when finished.
|
||||
func NewTestServer(
|
||||
log *slog.Logger,
|
||||
cfg *config.Config,
|
||||
database *db.Database,
|
||||
brk *broker.Broker,
|
||||
interval, deadline time.Duration,
|
||||
resolve func(ctx context.Context, addr string) string,
|
||||
) *Server {
|
||||
globs := &globals.Globals{
|
||||
Appname: "neoirc",
|
||||
Version: "test",
|
||||
StartTime: time.Now(),
|
||||
}
|
||||
|
||||
svc := service.NewTestService(
|
||||
database, brk, cfg, log,
|
||||
database, brk, cfg, globs, log,
|
||||
)
|
||||
|
||||
return &Server{ //nolint:exhaustruct
|
||||
@@ -30,9 +43,19 @@ func NewTestServer(
|
||||
brk: brk,
|
||||
svc: svc,
|
||||
conns: make(map[*Conn]struct{}),
|
||||
|
||||
pingInterval: interval,
|
||||
pongDeadline: deadline,
|
||||
resolveHost: resolve,
|
||||
}
|
||||
}
|
||||
|
||||
// ResolveHost is the reverse DNS lookup that a server made by
|
||||
// New does for each client.
|
||||
func ResolveHost(ctx context.Context, addr string) string {
|
||||
return resolveHost(ctx, addr)
|
||||
}
|
||||
|
||||
// Start exposes the unexported start method for tests.
|
||||
func (s *Server) Start(addr string) error {
|
||||
return s.start(context.Background(), addr)
|
||||
@@ -47,3 +70,49 @@ func (s *Server) Stop() {
|
||||
func (s *Server) Listener() net.Listener {
|
||||
return s.listener
|
||||
}
|
||||
|
||||
// Service returns the service the server's connections use.
|
||||
func (s *Server) Service() *service.Service {
|
||||
return s.svc
|
||||
}
|
||||
|
||||
// PingTimes returns how long the server's connections wait
|
||||
// with nothing read before they are sent a PING, and after it
|
||||
// before they are closed.
|
||||
func (s *Server) PingTimes() (time.Duration, time.Duration) {
|
||||
return s.pingInterval, s.pongDeadline
|
||||
}
|
||||
|
||||
// KillWriteWindow is how long Disconnect allows each write
|
||||
// to a killed victim.
|
||||
const KillWriteWindow = killWriteWindow
|
||||
|
||||
// PollInterval is how often the relay checks the client
|
||||
// output queue when no broker notification arrives.
|
||||
const PollInterval = pollInterval
|
||||
|
||||
// PingInterval is how long the server waits with nothing read
|
||||
// from a connection before it sends a PING.
|
||||
const PingInterval = pingInterval
|
||||
|
||||
// PongDeadline is how long the server waits after the PING
|
||||
// for a line before it closes the connection.
|
||||
const PongDeadline = pongDeadline
|
||||
|
||||
// StopTimeout is the longest Stop waits for the connections'
|
||||
// cleanup.
|
||||
const StopTimeout = stopTimeout
|
||||
|
||||
// NewTestConn returns a Conn for nick on tcpConn, without a
|
||||
// server, database or service behind it.
|
||||
func NewTestConn(
|
||||
log *slog.Logger,
|
||||
cfg *config.Config,
|
||||
tcpConn net.Conn,
|
||||
nick string,
|
||||
) *Conn {
|
||||
conn := newConn(tcpConn, log, nil, nil, cfg, nil)
|
||||
conn.nick = nick
|
||||
|
||||
return conn
|
||||
}
|
||||
|
||||
@@ -4,6 +4,8 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/config"
|
||||
)
|
||||
|
||||
// TestIntegrationTwoClients is a comprehensive integration
|
||||
@@ -762,6 +764,373 @@ func TestIntegrationTwoClients(t *testing.T) {
|
||||
)
|
||||
}
|
||||
|
||||
// ── Tier 3 Utility Command Integration Tests ──────────
|
||||
|
||||
// TestIntegrationUserhost verifies the USERHOST command
|
||||
// returns user@host info for connected nicks.
|
||||
func TestIntegrationUserhost(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
bob.send("AWAY :lunch")
|
||||
bob.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 306 ")
|
||||
})
|
||||
|
||||
for _, step := range []struct {
|
||||
line, want string
|
||||
}{
|
||||
{"USERHOST alice", " 302 alice alice=+alice@"},
|
||||
{"USERHOST alice bob", " :alice=+alice@"},
|
||||
{"USERHOST alice bob", " bob=-bob@"},
|
||||
{"USERHOST nobody", " 302 alice :"},
|
||||
{"USERHOST", " 461 alice USERHOST :"},
|
||||
} {
|
||||
alice.send(step.line)
|
||||
|
||||
reply := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 302 ") ||
|
||||
strings.Contains(l, " 461 ")
|
||||
})
|
||||
assertContains(t, reply, step.want, step.line)
|
||||
}
|
||||
}
|
||||
|
||||
// TestIntegrationVersion verifies the VERSION command
|
||||
// returns the server version string.
|
||||
func TestIntegrationVersion(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
alice.send("VERSION")
|
||||
|
||||
aliceReply := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 351 ")
|
||||
})
|
||||
assertContains(
|
||||
t, aliceReply, " 351 ",
|
||||
"RPL_VERSION",
|
||||
)
|
||||
assertContains(
|
||||
t, aliceReply, "neoirc",
|
||||
"VERSION reply contains server name",
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationAdmin verifies the ADMIN command returns
|
||||
// server admin info (256–259 numerics).
|
||||
func TestIntegrationAdmin(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
alice.send("ADMIN")
|
||||
|
||||
aliceReply := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 259 ")
|
||||
})
|
||||
assertContains(
|
||||
t, aliceReply, " 256 ",
|
||||
"RPL_ADMINME",
|
||||
)
|
||||
assertContains(
|
||||
t, aliceReply, " 257 ",
|
||||
"RPL_ADMINLOC1",
|
||||
)
|
||||
assertContains(
|
||||
t, aliceReply, " 258 ",
|
||||
"RPL_ADMINLOC2",
|
||||
)
|
||||
assertContains(
|
||||
t, aliceReply, " 259 ",
|
||||
"RPL_ADMINEMAIL",
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationInfo verifies the INFO command returns
|
||||
// server information (371/374 numerics).
|
||||
func TestIntegrationInfo(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
alice.send("INFO")
|
||||
|
||||
aliceReply := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 374 ")
|
||||
})
|
||||
assertContains(
|
||||
t, aliceReply, " 371 ",
|
||||
"RPL_INFO",
|
||||
)
|
||||
assertContains(
|
||||
t, aliceReply, " 374 ",
|
||||
"RPL_ENDOFINFO",
|
||||
)
|
||||
assertContains(
|
||||
t, aliceReply, "neoirc",
|
||||
"INFO reply mentions server name",
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationTime verifies the TIME command returns
|
||||
// the server time (391 numeric).
|
||||
func TestIntegrationTime(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
alice.send("TIME")
|
||||
|
||||
aliceReply := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 391 ")
|
||||
})
|
||||
assertContains(
|
||||
t, aliceReply, " 391 ",
|
||||
"RPL_TIME",
|
||||
)
|
||||
assertContains(
|
||||
t, aliceReply, testServerName,
|
||||
"TIME reply includes server name",
|
||||
)
|
||||
}
|
||||
|
||||
// becomeOper sends OPER with newTestEnvWithOper's
|
||||
// credentials and waits for RPL_YOUREOPER.
|
||||
func (tc *testClient) becomeOper() {
|
||||
tc.t.Helper()
|
||||
|
||||
tc.send("OPER testoper testpass")
|
||||
tc.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 381 ")
|
||||
})
|
||||
}
|
||||
|
||||
// TestIntegrationKillRefused covers the KILL errors: not an
|
||||
// operator, no such nick, and killing yourself.
|
||||
func TestIntegrationKillRefused(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnvWithOper(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
for _, step := range []struct {
|
||||
line, numeric string
|
||||
}{
|
||||
{"KILL bob :nope", " 481 "},
|
||||
{"OPER testoper testpass", " 381 "},
|
||||
{"KILL nobody123 :gone", " 401 "},
|
||||
{"KILL alice :me", " 483 "},
|
||||
} {
|
||||
alice.send(step.line)
|
||||
|
||||
reply := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, step.numeric)
|
||||
})
|
||||
assertContains(t, reply, step.numeric, step.line)
|
||||
}
|
||||
}
|
||||
|
||||
// TestIntegrationKill checks that the victim of a KILL is
|
||||
// told why, is disconnected, and is gone from its channels.
|
||||
func TestIntegrationKill(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnvWithOper(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
alice.joinAndDrain("#killtest")
|
||||
bob.joinAndDrain("#killtest")
|
||||
|
||||
// Drain alice's view of bob's join.
|
||||
alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, "JOIN") &&
|
||||
strings.Contains(l, "bob")
|
||||
})
|
||||
|
||||
alice.becomeOper()
|
||||
alice.send("KILL bob :bad behavior")
|
||||
|
||||
bobLines := bob.readUntilClosed()
|
||||
assertContains(
|
||||
t, bobLines, "KILL",
|
||||
"victim receives KILL before disconnect",
|
||||
)
|
||||
assertContains(
|
||||
t, bobLines, "ERROR :Closing Link",
|
||||
"victim receives ERROR before disconnect",
|
||||
)
|
||||
assertContains(
|
||||
t, bobLines, "bad behavior",
|
||||
"KILL reason delivered to victim",
|
||||
)
|
||||
|
||||
// alice should see bob's QUIT relay.
|
||||
aliceSeesQuit := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, "QUIT") &&
|
||||
strings.Contains(l, "bob")
|
||||
})
|
||||
assertContains(
|
||||
t, aliceSeesQuit, "Killed",
|
||||
"KILL reason in QUIT message",
|
||||
)
|
||||
|
||||
// bob must be gone from the channel member list.
|
||||
alice.send("NAMES #killtest")
|
||||
|
||||
aliceNames := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 366 ")
|
||||
})
|
||||
assertContains(
|
||||
t, aliceNames, "alice",
|
||||
"alice still in NAMES after killing bob",
|
||||
)
|
||||
assertNotContains(
|
||||
t, aliceNames, "bob",
|
||||
"killed user must not appear in NAMES",
|
||||
)
|
||||
|
||||
// ...nor from WHO.
|
||||
alice.send("WHO #killtest")
|
||||
|
||||
aliceWho := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 315 ")
|
||||
})
|
||||
assertNotContains(
|
||||
t, aliceWho, "bob",
|
||||
"killed user must not appear in WHO",
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationWallops verifies the WALLOPS command:
|
||||
// oper can broadcast to +w users.
|
||||
func TestIntegrationWallops(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnvWithOper(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
// Non-oper WALLOPS should fail.
|
||||
alice.send("WALLOPS :test broadcast")
|
||||
|
||||
aliceWallopsFail := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 481 ")
|
||||
})
|
||||
assertContains(
|
||||
t, aliceWallopsFail, " 481 ",
|
||||
"ERR_NOPRIVILEGES for non-oper WALLOPS",
|
||||
)
|
||||
|
||||
alice.becomeOper()
|
||||
|
||||
// bob sets +w to receive wallops.
|
||||
bob.send("MODE bob +w")
|
||||
bob.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 221 ")
|
||||
})
|
||||
|
||||
// alice sends WALLOPS.
|
||||
alice.send("WALLOPS :important announcement")
|
||||
|
||||
// bob (who has +w) should receive it.
|
||||
bobWallops := bob.readUntil(func(l string) bool {
|
||||
return strings.Contains(
|
||||
l, "important announcement",
|
||||
)
|
||||
})
|
||||
assertContains(
|
||||
t, bobWallops, "important announcement",
|
||||
"bob receives WALLOPS message",
|
||||
)
|
||||
assertContains(
|
||||
t, bobWallops, "WALLOPS",
|
||||
"message is WALLOPS command",
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationUserMode covers MODE for a nick: changes
|
||||
// and queries of your own modes, refusal for another nick,
|
||||
// even one that differs from yours only in letter case, and
|
||||
// a rejected mode string changing nothing.
|
||||
func TestIntegrationUserMode(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
const (
|
||||
notYours = " 502 alice :Can't change mode for other users"
|
||||
unknown = " 501 alice :Unknown MODE flag"
|
||||
)
|
||||
|
||||
for _, step := range []struct {
|
||||
line, want string
|
||||
}{
|
||||
{"MODE alice +w", " 221 alice +w"},
|
||||
{"MODE Alice", notYours},
|
||||
{"MODE Alice -w", notYours},
|
||||
{"MODE bob", notYours},
|
||||
{"MODE bob -w", notYours},
|
||||
{"MODE alice xw", unknown},
|
||||
{"MODE alice -w+z", unknown},
|
||||
{"MODE alice", " 221 alice +w"},
|
||||
{"MODE alice +w-w", " 221 alice +"},
|
||||
} {
|
||||
alice.send(step.line)
|
||||
|
||||
reply := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " 221 ") ||
|
||||
strings.Contains(l, " 501 ") ||
|
||||
strings.Contains(l, " 502 ")
|
||||
})
|
||||
|
||||
last := reply[len(reply)-1]
|
||||
if !strings.HasSuffix(last, step.want) {
|
||||
t.Errorf("%s: want %q, got %q", step.line, step.want, last)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestIntegrationModeSecret tests +s (secret) channel
|
||||
// mode — verifies that +s can be set and the mode is
|
||||
// reflected in MODE queries.
|
||||
@@ -872,6 +1241,252 @@ func TestIntegrationModeModerated(t *testing.T) {
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationModeKey checks that JOIN takes the key of
|
||||
// a +k channel as its second parameter, and that with
|
||||
// several channels each key goes to the channel in the
|
||||
// same position.
|
||||
func TestIntegrationModeKey(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#keyed")
|
||||
alice.joinAndDrain("#vault")
|
||||
|
||||
// The IRC listener cannot set +k, so the test sets the
|
||||
// keys directly.
|
||||
for channel, key := range map[string]string{
|
||||
"#keyed": "sesame",
|
||||
"#vault": "barley",
|
||||
} {
|
||||
chID, err := env.database.GetChannelByName(
|
||||
t.Context(), channel,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("get channel %s: %v", channel, err)
|
||||
}
|
||||
|
||||
err = env.database.SetChannelKey(t.Context(), chID, key)
|
||||
if err != nil {
|
||||
t.Fatalf("set key of %s: %v", channel, err)
|
||||
}
|
||||
}
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
bob.sendAndExpect("JOIN #keyed", " 475 ")
|
||||
bob.sendAndExpect("JOIN #keyed wrong", " 475 ")
|
||||
|
||||
lines := bob.sendAndExpect("JOIN #keyed sesame", " 366 ")
|
||||
assertContains(
|
||||
t, lines, "JOIN #keyed", "bob joins with the key",
|
||||
)
|
||||
|
||||
carol := env.dial(t)
|
||||
carol.register("carol")
|
||||
|
||||
lines = carol.sendAndExpect(
|
||||
"JOIN #keyed,#vault sesame,barley", " 366 carol #vault ",
|
||||
)
|
||||
assertContains(t, lines, "JOIN #keyed", "carol joins #keyed")
|
||||
assertContains(t, lines, "JOIN #vault", "carol joins #vault")
|
||||
assertNotContains(t, lines, " 475 ", "carol's JOIN")
|
||||
}
|
||||
|
||||
// TestIntegrationModeInviteOnly checks that INVITE lets a
|
||||
// user into a +i channel.
|
||||
func TestIntegrationModeInviteOnly(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#invonly")
|
||||
alice.sendAndExpect("MODE #invonly +i", "+i")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
bob.sendAndExpect("JOIN #invonly", " 473 ")
|
||||
|
||||
alice.sendAndExpect("INVITE bob #invonly", " 341 ")
|
||||
|
||||
lines := bob.sendAndExpect("JOIN #invonly", " 366 ")
|
||||
assertContains(
|
||||
t, lines, "JOIN #invonly", "bob joins once invited",
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationModeInviteOnlyNeedsOperator checks that on
|
||||
// a +i channel an INVITE from a member who is not a channel
|
||||
// operator gets 482 and does not let the invited user in.
|
||||
func TestIntegrationModeInviteOnlyNeedsOperator(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#invonly")
|
||||
|
||||
// Bob joins before +i is set, so he is a member but
|
||||
// not an operator.
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
bob.joinAndDrain("#invonly")
|
||||
|
||||
alice.sendAndExpect("MODE #invonly +i", "+i")
|
||||
|
||||
carol := env.dial(t)
|
||||
carol.register("carol")
|
||||
|
||||
lines := bob.sendAndExpect("INVITE carol #invonly", " 482 ")
|
||||
assertContains(
|
||||
t, lines, " 482 bob #invonly ", "bob's INVITE refused",
|
||||
)
|
||||
|
||||
carol.sendAndExpect("JOIN #invonly", " 473 ")
|
||||
}
|
||||
|
||||
// TestIntegrationInviteUserOnChannel checks that inviting a
|
||||
// user who is already on the channel gets 443.
|
||||
func TestIntegrationInviteUserOnChannel(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#room")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
bob.joinAndDrain("#room")
|
||||
|
||||
lines := alice.sendAndExpect("INVITE bob #room", " 443 ")
|
||||
assertContains(
|
||||
t, lines, " 443 alice bob #room ", "alice's INVITE refused",
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationInviteLine checks that an IRC listener user
|
||||
// invited by an IRC listener user, and then over the HTTP
|
||||
// API, gets an INVITE line from the inviter for the channel
|
||||
// each time.
|
||||
func TestIntegrationInviteLine(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#inv")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
alice.sendAndExpect("INVITE bob #inv", " 341 ")
|
||||
|
||||
got := bob.readLine()
|
||||
want := ":alice!alice@* INVITE bob #inv"
|
||||
|
||||
if got != want {
|
||||
t.Errorf("from the IRC listener: got %q, want %q", got, want)
|
||||
}
|
||||
|
||||
// The HTTP API queues an INVITE with the channel as its body.
|
||||
env.queueMessage(t, "bob", "INVITE", "carol", "bob", []string{"#inv"})
|
||||
|
||||
got = bob.readLine()
|
||||
want = ":carol!carol@* INVITE bob #inv"
|
||||
|
||||
if got != want {
|
||||
t.Errorf("over the HTTP API: got %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// TestIntegrationModeSecretList checks that LIST shows a +s
|
||||
// channel only to its members.
|
||||
func TestIntegrationModeSecretList(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#hidden")
|
||||
alice.joinAndDrain("#visible")
|
||||
alice.sendAndExpect("MODE #hidden +s", "+s")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
bobList := bob.sendAndExpect("LIST", " 323 ")
|
||||
assertContains(
|
||||
t, bobList, " 322 bob #visible ", "bob's LIST",
|
||||
)
|
||||
assertNotContains(t, bobList, "#hidden", "bob's LIST")
|
||||
|
||||
aliceList := alice.sendAndExpect("LIST", " 323 ")
|
||||
assertContains(
|
||||
t, aliceList, " 322 alice #hidden ", "alice's LIST",
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationModeSecretWhois checks that WHOIS names a
|
||||
// +s channel only to users on it.
|
||||
func TestIntegrationModeSecretWhois(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#hidden")
|
||||
alice.joinAndDrain("#visible")
|
||||
alice.sendAndExpect("MODE #hidden +s", "+s")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
bobWhois := bob.sendAndExpect("WHOIS alice", " 318 ")
|
||||
assertContains(t, bobWhois, "@#visible", "bob's WHOIS")
|
||||
assertNotContains(t, bobWhois, "#hidden", "bob's WHOIS")
|
||||
|
||||
carol := env.dial(t)
|
||||
carol.register("carol")
|
||||
carol.joinAndDrain("#hidden")
|
||||
|
||||
carolWhois := carol.sendAndExpect("WHOIS alice", " 318 ")
|
||||
assertContains(t, carolWhois, "@#hidden", "carol's WHOIS")
|
||||
}
|
||||
|
||||
// TestIntegrationModeHashcash checks that PRIVMSG to a +H
|
||||
// channel is refused, since an IRC client cannot attach a
|
||||
// hashcash stamp.
|
||||
func TestIntegrationModeHashcash(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#stamped")
|
||||
alice.sendAndExpect("MODE #stamped +H 2", "+H")
|
||||
|
||||
lines := alice.sendAndExpect(
|
||||
"PRIVMSG #stamped :hello", " 404 ",
|
||||
)
|
||||
assertContains(
|
||||
t, lines, " 404 alice #stamped :Channel requires hashcash",
|
||||
"PRIVMSG refused",
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationThirdClientObserver verifies that a third
|
||||
// client observing the same channel receives messages from
|
||||
// the other two.
|
||||
@@ -915,3 +1530,30 @@ func TestIntegrationThirdClientObserver(t *testing.T) {
|
||||
"carol receives trio message",
|
||||
)
|
||||
}
|
||||
|
||||
// TestIntegrationDefaultServerNameFallback checks that with
|
||||
// SERVER_NAME unset, as it is by default, VERSION, ADMIN and
|
||||
// TIME name the server "neoirc".
|
||||
func TestIntegrationDefaultServerNameFallback(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnvWithConfig(t, &config.Config{})
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
for _, step := range []struct {
|
||||
line, lastNumeric, want string
|
||||
}{
|
||||
{"VERSION", " 351 ", " 351 alice neoirc-test. neoirc "},
|
||||
{"ADMIN", " 259 ", " 256 alice neoirc "},
|
||||
{"TIME", " 391 ", " 391 alice neoirc "},
|
||||
} {
|
||||
alice.send(step.line)
|
||||
|
||||
reply := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, step.lastNumeric)
|
||||
})
|
||||
assertContains(t, reply, step.want, step.line)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -90,7 +90,10 @@ func ParseMessage(line string) *Message {
|
||||
}
|
||||
|
||||
// FormatMessage formats an IRC message into wire protocol
|
||||
// format (without the trailing CR-LF).
|
||||
// format (without the trailing CR-LF). CR, LF and NUL are
|
||||
// removed from each parameter, because on the wire they would
|
||||
// end the line early; this happens before deciding whether
|
||||
// the last parameter needs a leading ':'.
|
||||
func FormatMessage(
|
||||
prefix, command string,
|
||||
params ...string,
|
||||
@@ -106,6 +109,10 @@ func FormatMessage(
|
||||
buf.WriteString(command)
|
||||
|
||||
for i, param := range params {
|
||||
param = strings.ReplaceAll(param, "\r", "")
|
||||
param = strings.ReplaceAll(param, "\n", "")
|
||||
param = strings.ReplaceAll(param, "\x00", "")
|
||||
|
||||
buf.WriteByte(' ')
|
||||
|
||||
isLast := i == len(params)-1
|
||||
|
||||
+77
-63
@@ -3,6 +3,7 @@ package ircserver
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"slices"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
@@ -26,22 +27,34 @@ func (c *Conn) relayMessages(ctx context.Context) {
|
||||
default:
|
||||
}
|
||||
|
||||
// Drain any available messages.
|
||||
delivered := c.drainQueue(ctx)
|
||||
// Register with the broker before draining, so that a
|
||||
// message queued after the drain has read the queue
|
||||
// still signals waitCh.
|
||||
waitCh := c.brk.Wait(c.sessionID)
|
||||
|
||||
// Drain any available messages. The drain ignores the
|
||||
// cancel that comes when the connection ends, because a
|
||||
// query cancelled while it runs leaves the SQLite
|
||||
// connection marked broken, and the pool closes it. The
|
||||
// loop still stops on ctx.
|
||||
delivered := c.drainQueue(context.WithoutCancel(ctx))
|
||||
|
||||
if delivered {
|
||||
c.brk.Remove(c.sessionID, waitCh)
|
||||
|
||||
// Tight loop while there are messages.
|
||||
continue
|
||||
}
|
||||
|
||||
// Wait for notification or timeout.
|
||||
waitCh := c.brk.Wait(c.sessionID)
|
||||
|
||||
select {
|
||||
case <-waitCh:
|
||||
// New message notification — loop back.
|
||||
case <-ticker.C:
|
||||
// Periodic check.
|
||||
// Periodic check. Nothing used waitCh, so take it
|
||||
// out of the broker before the next pass adds
|
||||
// another.
|
||||
c.brk.Remove(c.sessionID, waitCh)
|
||||
case <-ctx.Done():
|
||||
c.brk.Remove(c.sessionID, waitCh)
|
||||
|
||||
@@ -83,7 +96,7 @@ func (c *Conn) drainQueue(ctx context.Context) bool {
|
||||
//
|
||||
//nolint:cyclop // dispatch table
|
||||
func (c *Conn) deliverIRCMessage(
|
||||
_ context.Context,
|
||||
ctx context.Context,
|
||||
msg *db.IRCMessage,
|
||||
) {
|
||||
command := msg.Command
|
||||
@@ -105,13 +118,13 @@ func (c *Conn) deliverIRCMessage(
|
||||
case isNumeric(command):
|
||||
c.deliverNumeric(msg, text)
|
||||
case command == irc.CmdPrivmsg || command == irc.CmdNotice:
|
||||
c.deliverTextMessage(msg, command, text)
|
||||
c.deliverTextMessage(msg, command, bodyLines)
|
||||
case command == irc.CmdJoin:
|
||||
c.deliverJoin(msg)
|
||||
case command == irc.CmdPart:
|
||||
c.deliverPart(msg, text)
|
||||
case command == irc.CmdNick:
|
||||
c.deliverNickChange(msg, text)
|
||||
c.deliverNickChange(ctx, msg, text)
|
||||
case command == irc.CmdQuit:
|
||||
c.deliverQuitMsg(msg, text)
|
||||
case command == irc.CmdTopic:
|
||||
@@ -120,8 +133,10 @@ func (c *Conn) deliverIRCMessage(
|
||||
c.deliverKickMsg(msg, text)
|
||||
case command == "INVITE":
|
||||
c.deliverInviteMsg(msg, text)
|
||||
case command == irc.CmdWallops:
|
||||
c.deliverWallops(msg, text)
|
||||
case command == irc.CmdMode:
|
||||
c.deliverMode(msg, text)
|
||||
c.deliverMode(msg, bodyLines)
|
||||
case command == irc.CmdPing:
|
||||
// Server-originated PING — reply with PONG.
|
||||
c.sendFromServer("PING", c.serverSfx)
|
||||
@@ -177,43 +192,28 @@ func (c *Conn) deliverNumeric(
|
||||
c.send(FormatMessage(from, msg.Command, allParams...))
|
||||
}
|
||||
|
||||
// deliverTextMessage sends PRIVMSG or NOTICE.
|
||||
// deliverTextMessage sends PRIVMSG or NOTICE, one line for
|
||||
// each line of the body.
|
||||
func (c *Conn) deliverTextMessage(
|
||||
msg *db.IRCMessage,
|
||||
command, text string,
|
||||
command string,
|
||||
bodyLines []string,
|
||||
) {
|
||||
from := msg.From
|
||||
target := msg.To
|
||||
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
// Don't echo our own messages back.
|
||||
if strings.EqualFold(from, nick) {
|
||||
return
|
||||
}
|
||||
|
||||
prefix := from
|
||||
if !strings.Contains(prefix, "!") {
|
||||
prefix = from + "!" + from + "@*"
|
||||
}
|
||||
|
||||
c.send(FormatMessage(prefix, command, target, text))
|
||||
for _, line := range bodyLines {
|
||||
c.send(FormatMessage(prefix, command, target, line))
|
||||
}
|
||||
}
|
||||
|
||||
// deliverJoin sends a JOIN notification.
|
||||
func (c *Conn) deliverJoin(msg *db.IRCMessage) {
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
// Don't echo our own JOINs (we already sent them
|
||||
// during joinChannel).
|
||||
if strings.EqualFold(msg.From, nick) {
|
||||
return
|
||||
}
|
||||
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
channel := msg.To
|
||||
|
||||
@@ -222,14 +222,6 @@ func (c *Conn) deliverJoin(msg *db.IRCMessage) {
|
||||
|
||||
// deliverPart sends a PART notification.
|
||||
func (c *Conn) deliverPart(msg *db.IRCMessage, text string) {
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
if strings.EqualFold(msg.From, nick) {
|
||||
return
|
||||
}
|
||||
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
channel := msg.To
|
||||
|
||||
@@ -242,18 +234,17 @@ func (c *Conn) deliverPart(msg *db.IRCMessage, text string) {
|
||||
}
|
||||
}
|
||||
|
||||
// deliverNickChange sends a NICK change notification.
|
||||
// deliverNickChange sends a NICK change notification. The
|
||||
// change may be its own session's, made from another client,
|
||||
// so the connection first takes the nick its session holds
|
||||
// now. It does not go by the line's old nick: the connection
|
||||
// may have taken that nick after another user gave it up.
|
||||
func (c *Conn) deliverNickChange(
|
||||
ctx context.Context,
|
||||
msg *db.IRCMessage,
|
||||
newNick string,
|
||||
) {
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
if strings.EqualFold(msg.From, nick) {
|
||||
return
|
||||
}
|
||||
c.loadSessionNick(ctx)
|
||||
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
|
||||
@@ -265,14 +256,6 @@ func (c *Conn) deliverQuitMsg(
|
||||
msg *db.IRCMessage,
|
||||
text string,
|
||||
) {
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
if strings.EqualFold(msg.From, nick) {
|
||||
return
|
||||
}
|
||||
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
|
||||
if text != "" {
|
||||
@@ -325,27 +308,58 @@ func (c *Conn) deliverKickMsg(
|
||||
}
|
||||
}
|
||||
|
||||
// deliverInviteMsg sends an INVITE notification.
|
||||
// deliverInviteMsg sends an INVITE line from the inviter
|
||||
// for the channel named in text, or nothing when text names
|
||||
// no channel.
|
||||
func (c *Conn) deliverInviteMsg(
|
||||
_ *db.IRCMessage,
|
||||
msg *db.IRCMessage,
|
||||
text string,
|
||||
) {
|
||||
if text == "" {
|
||||
return
|
||||
}
|
||||
|
||||
c.mu.Lock()
|
||||
nick := c.nick
|
||||
c.mu.Unlock()
|
||||
|
||||
c.sendFromServer("NOTICE", nick, text)
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
|
||||
c.send(FormatMessage(prefix, "INVITE", nick, text))
|
||||
}
|
||||
|
||||
// deliverMode sends a MODE change notification.
|
||||
func (c *Conn) deliverMode(
|
||||
// deliverWallops sends a WALLOPS notification.
|
||||
func (c *Conn) deliverWallops(
|
||||
msg *db.IRCMessage,
|
||||
text string,
|
||||
) {
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
target := msg.To
|
||||
|
||||
if text != "" {
|
||||
c.send(FormatMessage(prefix, "MODE", target, text))
|
||||
c.send(FormatMessage(
|
||||
prefix, irc.CmdWallops, text,
|
||||
))
|
||||
}
|
||||
|
||||
// deliverMode sends a MODE change notification. The first
|
||||
// body line is the change, possibly followed by its values
|
||||
// separated by spaces ("+o bob"); any further lines are
|
||||
// values ("+k", "secret"). Each goes out as its own
|
||||
// parameter, as IRC sends them.
|
||||
func (c *Conn) deliverMode(
|
||||
msg *db.IRCMessage,
|
||||
bodyLines []string,
|
||||
) {
|
||||
if len(bodyLines) == 0 || bodyLines[0] == "" {
|
||||
return
|
||||
}
|
||||
|
||||
prefix := msg.From + "!" + msg.From + "@*"
|
||||
|
||||
params := slices.Concat(
|
||||
[]string{msg.To},
|
||||
strings.Fields(bodyLines[0]),
|
||||
bodyLines[1:],
|
||||
)
|
||||
|
||||
c.send(FormatMessage(prefix, "MODE", params...))
|
||||
}
|
||||
|
||||
@@ -0,0 +1,697 @@
|
||||
package ircserver_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"slices"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/ircserver"
|
||||
"sneak.berlin/go/neoirc/internal/service"
|
||||
)
|
||||
|
||||
// queueMessage queues a message for the user with nick
|
||||
// recipient the way the HTTP API sends one: stored once, then
|
||||
// queued to the recipient's session.
|
||||
func (env *testEnv) queueMessage(
|
||||
t *testing.T,
|
||||
recipient, command, from, to string,
|
||||
body []string,
|
||||
) {
|
||||
t.Helper()
|
||||
|
||||
ctx := t.Context()
|
||||
|
||||
bodyJSON, err := json.Marshal(body)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal body: %v", err)
|
||||
}
|
||||
|
||||
msgID, _, err := env.database.InsertMessage(
|
||||
ctx, command, from, to, 0, 0, nil, bodyJSON, nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("insert message: %v", err)
|
||||
}
|
||||
|
||||
sessionID, err := env.database.GetSessionByNick(ctx, recipient)
|
||||
if err != nil {
|
||||
t.Fatalf("get session of %s: %v", recipient, err)
|
||||
}
|
||||
|
||||
err = env.database.EnqueueToSession(ctx, sessionID, msgID, 0)
|
||||
if err != nil {
|
||||
t.Fatalf("enqueue: %v", err)
|
||||
}
|
||||
|
||||
env.brk.Notify(sessionID)
|
||||
}
|
||||
|
||||
// TestRelayKeepsOneWaitChannel checks that an IRC listener
|
||||
// connection holds at most one broker wait channel across
|
||||
// several relay ticks, both while idle and after the relay
|
||||
// has delivered it a message, and none once it closes.
|
||||
func TestRelayKeepsOneWaitChannel(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
client := env.dial(t)
|
||||
client.register("idle")
|
||||
|
||||
sessionID, err := env.database.GetSessionByNick(t.Context(), "idle")
|
||||
if err != nil {
|
||||
t.Fatalf("get session of idle: %v", err)
|
||||
}
|
||||
|
||||
env.checkOneWaitChannel(t, sessionID)
|
||||
|
||||
env.queueMessage(
|
||||
t, "idle", "PRIVMSG", "carol", "idle", []string{"hello"},
|
||||
)
|
||||
|
||||
client.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, "hello")
|
||||
})
|
||||
|
||||
env.checkOneWaitChannel(t, sessionID)
|
||||
|
||||
err = client.conn.Close()
|
||||
if err != nil {
|
||||
t.Fatalf("close: %v", err)
|
||||
}
|
||||
|
||||
deadline := time.Now().Add(testTimeout)
|
||||
|
||||
for env.brk.ListenerCount(sessionID) != 0 {
|
||||
if time.Now().After(deadline) {
|
||||
t.Fatalf("after close: got %d wait channels, want 0",
|
||||
env.brk.ListenerCount(sessionID))
|
||||
}
|
||||
|
||||
time.Sleep(relayCheckStep)
|
||||
}
|
||||
}
|
||||
|
||||
// checkOneWaitChannel fails the test if the session
|
||||
// sessionID holds more than one broker wait channel at any of
|
||||
// several relay ticks.
|
||||
func (env *testEnv) checkOneWaitChannel(
|
||||
t *testing.T,
|
||||
sessionID int64,
|
||||
) {
|
||||
t.Helper()
|
||||
|
||||
const ticks = 5
|
||||
|
||||
for tick := range ticks {
|
||||
time.Sleep(ircserver.PollInterval)
|
||||
|
||||
got := env.brk.ListenerCount(sessionID)
|
||||
if got > 1 {
|
||||
t.Fatalf("tick %d: got %d wait channels, want at most 1",
|
||||
tick+1, got)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayMultiLineBody checks that each line of a PRIVMSG
|
||||
// or NOTICE body sent over the HTTP API reaches an IRC
|
||||
// listener user as its own line.
|
||||
func TestRelayMultiLineBody(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
for _, command := range []string{"PRIVMSG", "NOTICE"} {
|
||||
env.queueMessage(
|
||||
t, "alice", command, "carol", "alice",
|
||||
[]string{"first line", "second line"},
|
||||
)
|
||||
|
||||
lines := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, "second line")
|
||||
})
|
||||
|
||||
want := []string{
|
||||
":carol!carol@* " + command + " alice :first line",
|
||||
":carol!carol@* " + command + " alice :second line",
|
||||
}
|
||||
|
||||
got := lines[max(0, len(lines)-len(want)):]
|
||||
if !slices.Equal(got, want) {
|
||||
t.Errorf("%s: got %q, want %q", command, got, want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayModeParameters checks that a MODE change reaches
|
||||
// IRC listener members with its values as separate
|
||||
// parameters, both for the bodies the HTTP API stores and
|
||||
// for a change made on the IRC listener.
|
||||
func TestRelayModeParameters(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
|
||||
for _, step := range []struct {
|
||||
body []string
|
||||
want string
|
||||
}{
|
||||
{[]string{"+k", "secret"}, "+k secret"},
|
||||
{[]string{"-k", "*"}, "-k *"},
|
||||
{[]string{"+l", "50"}, "+l 50"},
|
||||
{[]string{"-l"}, "-l"},
|
||||
{[]string{"+b", "*!*@*.example.com"}, "+b *!*@*.example.com"},
|
||||
{[]string{"-b", "*!*@*.example.com"}, "-b *!*@*.example.com"},
|
||||
{[]string{"+o bob"}, "+o bob"},
|
||||
{[]string{"+m"}, "+m"},
|
||||
} {
|
||||
env.queueMessage(t, "alice", "MODE", "op", "#modes", step.body)
|
||||
|
||||
lines := alice.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " MODE ")
|
||||
})
|
||||
|
||||
got := lines[len(lines)-1]
|
||||
want := ":op!op@* MODE #modes " + step.want
|
||||
|
||||
if got != want {
|
||||
t.Errorf("body %q: got %q, want %q", step.body, got, want)
|
||||
}
|
||||
}
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
alice.joinAndDrain("#modes")
|
||||
bob.joinAndDrain("#modes")
|
||||
|
||||
alice.send("MODE #modes +v bob")
|
||||
|
||||
const change = " MODE #modes +v bob"
|
||||
|
||||
for name, client := range map[string]*testClient{
|
||||
"alice": alice, "bob": bob,
|
||||
} {
|
||||
lines := client.readUntil(func(l string) bool {
|
||||
return strings.Contains(l, " MODE ")
|
||||
})
|
||||
|
||||
got := lines[len(lines)-1]
|
||||
if !strings.HasSuffix(got, change) {
|
||||
t.Errorf("%s: got %q, want it to end in %q", name, got, change)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayInviteWithoutChannel checks that an INVITE whose
|
||||
// body names no channel sends the invited IRC listener user
|
||||
// no INVITE line.
|
||||
func TestRelayInviteWithoutChannel(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
// A nil body is stored as JSON null, which is not an array.
|
||||
for _, body := range [][]string{nil, {}, {""}} {
|
||||
env.queueMessage(t, "bob", "INVITE", "carol", "bob", body)
|
||||
}
|
||||
|
||||
// The relay sends a user's queue in order, so this arrives
|
||||
// after anything sent for the INVITEs above.
|
||||
env.queueMessage(t, "bob", "PRIVMSG", "carol", "bob",
|
||||
[]string{"the end"})
|
||||
|
||||
lines := bob.readUntil(func(l string) bool {
|
||||
return strings.HasSuffix(l, " :the end")
|
||||
})
|
||||
|
||||
for _, line := range lines {
|
||||
if strings.Contains(line, " INVITE ") {
|
||||
t.Errorf("got %q, want no INVITE line", line)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayLineBreaks checks that a CR, LF or NUL in a stored
|
||||
// body line, key or mask never reaches an IRC listener user
|
||||
// as a line break, so no extra line arrives, and that a body
|
||||
// line keeps its parameter and leading ':' once they are
|
||||
// removed.
|
||||
func TestRelayLineBreaks(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
|
||||
env.queueMessage(t, "bob", "PRIVMSG", "carol", "bob", []string{
|
||||
"one\r\n:admin!a@b PRIVMSG bob :hi",
|
||||
"two\n:admin!a@b NOTICE bob :hi\x00",
|
||||
})
|
||||
env.queueMessage(t, "bob", "MODE", "op", "#breaks",
|
||||
[]string{"+k", "key\r\nERROR :Closing link"})
|
||||
env.queueMessage(t, "bob", "MODE", "op", "#breaks",
|
||||
[]string{"+b", "*!*@*\r\n:admin!a@b KICK #breaks bob"})
|
||||
env.queueMessage(t, "bob", "PRIVMSG", "carol", "bob",
|
||||
[]string{"\r\n", "\x00:hi"})
|
||||
env.queueMessage(t, "bob", "PRIVMSG", "carol", "bob",
|
||||
[]string{"the end"})
|
||||
|
||||
lines := bob.readUntil(func(l string) bool {
|
||||
return strings.HasSuffix(l, " :the end")
|
||||
})
|
||||
|
||||
want := []string{
|
||||
":carol!carol@* PRIVMSG bob :one:admin!a@b PRIVMSG bob :hi",
|
||||
":carol!carol@* PRIVMSG bob :two:admin!a@b NOTICE bob :hi",
|
||||
":op!op@* MODE #breaks +k :keyERROR :Closing link",
|
||||
":op!op@* MODE #breaks +b :*!*@*:admin!a@b KICK #breaks bob",
|
||||
":carol!carol@* PRIVMSG bob :",
|
||||
":carol!carol@* PRIVMSG bob ::hi",
|
||||
":carol!carol@* PRIVMSG bob :the end",
|
||||
}
|
||||
|
||||
got := lines[max(0, len(lines)-len(want)):]
|
||||
if !slices.Equal(got, want) {
|
||||
t.Errorf("got %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayNickDiffersOnlyInCase checks that an IRC listener
|
||||
// user alice receives a JOIN, PRIVMSG, PART, NICK and QUIT
|
||||
// from Alice in a channel they share: nicks are
|
||||
// case-sensitive, so Alice is someone else.
|
||||
func TestRelayNickDiffersOnlyInCase(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#case")
|
||||
|
||||
capitalAlice := env.dial(t)
|
||||
capitalAlice.register("Alice")
|
||||
|
||||
for _, step := range []struct {
|
||||
line, want string
|
||||
}{
|
||||
{"JOIN #case", ":Alice!Alice@* JOIN #case"},
|
||||
{"PRIVMSG #case :hi there", ":Alice!Alice@* PRIVMSG #case :hi there"},
|
||||
{"PART #case :see you", ":Alice!Alice@* PART #case :see you"},
|
||||
{"JOIN #case", ":Alice!Alice@* JOIN #case"},
|
||||
{"NICK Alicia", ":Alice!Alice@* NICK Alicia"},
|
||||
{"NICK Alice", ":Alicia!Alicia@* NICK Alice"}, // back for QUIT
|
||||
{"QUIT", ":Alice!Alice@* QUIT :Quit: Client quit"},
|
||||
} {
|
||||
capitalAlice.send(step.line)
|
||||
|
||||
got := alice.readLine()
|
||||
if got != step.want {
|
||||
t.Errorf("%s: got %q, want %q", step.line, got, step.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayOwnChangeOnce checks that an IRC listener user who
|
||||
// sets a topic, changes a channel mode or kicks gets one TOPIC,
|
||||
// MODE or KICK line for it, and so does the other member.
|
||||
func TestRelayOwnChangeOnce(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
for _, step := range []struct {
|
||||
command, line string
|
||||
}{
|
||||
{"TOPIC", "TOPIC #dup :new topic"},
|
||||
{"MODE", "MODE #dup +m"},
|
||||
{"KICK", "KICK #dup carl :bye"},
|
||||
} {
|
||||
t.Run(step.command, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.joinAndDrain("#dup")
|
||||
|
||||
carl := env.dial(t)
|
||||
carl.register("carl")
|
||||
carl.joinAndDrain("#dup")
|
||||
|
||||
alice.send(step.line)
|
||||
|
||||
// The reply to alice's next command comes after her
|
||||
// command has finished, so her own copy comes before it.
|
||||
beforePong := alice.sendAndExpect("PING :done", "PONG")
|
||||
|
||||
// The relay sends a user's queue in order, so a message
|
||||
// queued now arrives after any relayed copy.
|
||||
for nick, client := range map[string]*testClient{
|
||||
"alice": alice, "carl": carl,
|
||||
} {
|
||||
env.queueMessage(
|
||||
t, nick, "PRIVMSG", "dave", nick,
|
||||
[]string{"after the change"},
|
||||
)
|
||||
|
||||
lines := client.readUntil(func(l string) bool {
|
||||
return strings.HasSuffix(l, " :after the change")
|
||||
})
|
||||
|
||||
if client == alice {
|
||||
lines = slices.Concat(beforePong, lines)
|
||||
}
|
||||
|
||||
var changes []string
|
||||
|
||||
for _, line := range lines {
|
||||
if strings.Contains(line, " "+step.command+" #dup ") {
|
||||
changes = append(changes, line)
|
||||
}
|
||||
}
|
||||
|
||||
if len(changes) != 1 {
|
||||
t.Errorf("%s got %q, want one %s line",
|
||||
nick, changes, step.command)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayOwnSessionOnce checks that a command a user makes
|
||||
// from one client of their session reaches each of the
|
||||
// session's clients once: an IRC listener connection and an
|
||||
// HTTP API client. The connection that sent a command gets
|
||||
// only its own echo, and none for PRIVMSG and NOTICE, which
|
||||
// IRC does not echo.
|
||||
//
|
||||
//nolint:funlen // table-driven test
|
||||
func TestRelayOwnSessionOnce(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
hello := json.RawMessage(`["hello"]`)
|
||||
|
||||
for _, step := range []struct {
|
||||
// line is the command as alice sends it on the IRC
|
||||
// listener.
|
||||
line string
|
||||
// api makes the same command for her session the way
|
||||
// the HTTP API does.
|
||||
api func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error
|
||||
// echoes is how many copies alice's connection gets of
|
||||
// line when it sends line itself.
|
||||
echoes int
|
||||
}{
|
||||
{"PRIVMSG #chan :hello", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
_, err := svc.SendChannelMessage(
|
||||
ctx, sessionID, 0, "alice", "PRIVMSG", "#chan", hello, nil,
|
||||
)
|
||||
|
||||
return err
|
||||
}, 0},
|
||||
{"NOTICE bob :hello", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
_, err := svc.SendDirectMessage(
|
||||
ctx, sessionID, 0, "alice", "NOTICE", "bob", hello, nil,
|
||||
)
|
||||
|
||||
return err
|
||||
}, 0},
|
||||
{"JOIN #other", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
_, err := svc.JoinChannel(ctx, sessionID, 0, "alice", "#other", "")
|
||||
|
||||
return err
|
||||
}, 1},
|
||||
{"PART #chan :bye", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
return svc.PartChannel(ctx, sessionID, 0, "alice", "#chan", "bye")
|
||||
}, 1},
|
||||
{"NICK alice2", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
return svc.ChangeNick(ctx, sessionID, 0, "alice", "alice2")
|
||||
}, 1},
|
||||
{"TOPIC #chan :new topic", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
return svc.SetTopic(
|
||||
ctx, sessionID, 0, "alice", "#chan", "new topic",
|
||||
)
|
||||
}, 1},
|
||||
{"MODE #chan +m", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
chID, err := svc.ValidateChannelOp(ctx, sessionID, "#chan")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
err = svc.SetChannelFlag(ctx, chID, 'm', true)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
svc.BroadcastMode(ctx, 0, "alice", "#chan", chID, "+m")
|
||||
|
||||
return nil
|
||||
}, 1},
|
||||
{"KICK #chan bob :bye", func(
|
||||
ctx context.Context, svc *service.Service, sessionID int64,
|
||||
) error {
|
||||
return svc.KickUser(
|
||||
ctx, sessionID, 0, "alice", "#chan", "bob", "bye",
|
||||
)
|
||||
}, 1},
|
||||
} {
|
||||
command := strings.Fields(step.line)[0]
|
||||
|
||||
t.Run(command+" from IRC", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ircCopies, httpCopies := ownSessionCopies(t, step.line, nil)
|
||||
if ircCopies != step.echoes || httpCopies != 1 {
|
||||
t.Errorf("connection got %d, HTTP client got %d, want %d and 1",
|
||||
ircCopies, httpCopies, step.echoes)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run(command+" from the HTTP API", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ircCopies, httpCopies := ownSessionCopies(t, step.line, step.api)
|
||||
if ircCopies != 1 || httpCopies != 1 {
|
||||
t.Errorf("connection got %d, HTTP client got %d, want 1 and 1",
|
||||
ircCopies, httpCopies)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// ownSessionCopies sets up alice with aliceWithHTTPClient. It
|
||||
// makes the command line from her connection, or with api from
|
||||
// the HTTP API client when api is not nil, and returns how many
|
||||
// copies of it her connection and her HTTP API client got.
|
||||
func ownSessionCopies(
|
||||
t *testing.T,
|
||||
line string,
|
||||
api func(ctx context.Context, svc *service.Service, sessionID int64) error,
|
||||
) (int, int) {
|
||||
t.Helper()
|
||||
|
||||
ctx := t.Context()
|
||||
env := newTestEnv(t)
|
||||
alice, _, sessionID, httpClientID := aliceWithHTTPClient(t, env)
|
||||
|
||||
var lines []string
|
||||
|
||||
if api == nil {
|
||||
alice.send(line)
|
||||
|
||||
// Her echo comes before the reply to her next command.
|
||||
lines = alice.sendAndExpect("PING :done", "PONG")
|
||||
} else {
|
||||
err := api(ctx, env.srv.Service(), sessionID)
|
||||
if err != nil {
|
||||
t.Fatalf("%s over the HTTP API: %v", line, err)
|
||||
}
|
||||
}
|
||||
|
||||
msgs, _, err := env.database.PollMessages(ctx, httpClientID, 0, 0)
|
||||
if err != nil {
|
||||
t.Fatalf("poll the HTTP API client: %v", err)
|
||||
}
|
||||
|
||||
httpCopies := 0
|
||||
|
||||
for _, msg := range msgs {
|
||||
if msg.Command == strings.Fields(line)[0] {
|
||||
httpCopies++
|
||||
}
|
||||
}
|
||||
|
||||
// The relay sends a queue in order, so this arrives after any
|
||||
// copy. It is queued by session, as NICK changes her nick.
|
||||
endID, _, err := env.database.InsertMessage(
|
||||
ctx, "PRIVMSG", "dave", "alice", 0, 0,
|
||||
nil, json.RawMessage(`["the end"]`), nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("insert message: %v", err)
|
||||
}
|
||||
|
||||
err = env.database.EnqueueToSession(ctx, sessionID, endID, 0)
|
||||
if err != nil {
|
||||
t.Fatalf("enqueue: %v", err)
|
||||
}
|
||||
|
||||
env.brk.Notify(sessionID)
|
||||
|
||||
lines = append(lines, alice.readUntil(func(l string) bool {
|
||||
return strings.HasSuffix(l, " :the end")
|
||||
})...)
|
||||
|
||||
// A copy starts with the command and its first parameter.
|
||||
start := " " + strings.Join(strings.Fields(line)[:2], " ")
|
||||
ircCopies := strings.Count(strings.Join(lines, "\n"), start)
|
||||
|
||||
return ircCopies, httpCopies
|
||||
}
|
||||
|
||||
// aliceWithHTTPClient connects alice to the IRC listener and
|
||||
// has her join #chan, which bob is on too, then adds an HTTP API
|
||||
// client to her session with the password her connection set,
|
||||
// as POST /api/v1/login does. It returns her connection, bob's
|
||||
// connection, her session and her HTTP API client.
|
||||
func aliceWithHTTPClient(
|
||||
t *testing.T, env *testEnv,
|
||||
) (*testClient, *testClient, int64, int64) {
|
||||
t.Helper()
|
||||
|
||||
const password = "alicepass"
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.send("PASS " + password)
|
||||
alice.register("alice")
|
||||
// Registration stores the password before the JOIN runs.
|
||||
alice.joinAndDrain("#chan")
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
bob.joinAndDrain("#chan")
|
||||
|
||||
sessionID, httpClientID, _, err := env.database.LoginUser(
|
||||
t.Context(), "alice", password, "127.0.0.1", "localhost",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("log in as alice: %v", err)
|
||||
}
|
||||
|
||||
return alice, bob, sessionID, httpClientID
|
||||
}
|
||||
|
||||
// TestRelayNickChangeFromHTTPAPI checks that once alice's nick
|
||||
// is changed from her HTTP API client, her IRC listener
|
||||
// connection uses the new nick: what she then sends from it
|
||||
// reaches bob under the new nick.
|
||||
func TestRelayNickChangeFromHTTPAPI(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
alice, bob, sessionID, _ := aliceWithHTTPClient(t, env)
|
||||
|
||||
bob.joinAndDrain("#other")
|
||||
|
||||
// As the HTTP API does.
|
||||
err := env.srv.Service().ChangeNick(
|
||||
t.Context(), sessionID, 0, "alice", "alice2",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("change nick over the HTTP API: %v", err)
|
||||
}
|
||||
|
||||
// Her connection has taken the new nick once it has sent her
|
||||
// the change.
|
||||
const change = ":alice!alice@* NICK alice2"
|
||||
|
||||
alice.readUntil(func(l string) bool { return l == change })
|
||||
bob.readUntil(func(l string) bool { return l == change })
|
||||
|
||||
for _, step := range []struct {
|
||||
line, want string
|
||||
}{
|
||||
{"PRIVMSG #chan :hi there", ":alice2!alice2@* PRIVMSG #chan :hi there"},
|
||||
{"JOIN #other", ":alice2!alice2@* JOIN #other"},
|
||||
{"NICK alice3", ":alice2!alice2@* NICK alice3"},
|
||||
} {
|
||||
alice.send(step.line)
|
||||
|
||||
got := bob.readLine()
|
||||
if got != step.want {
|
||||
t.Errorf("%s: got %q, want %q", step.line, got, step.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestRelayNickChangeKeepsTakenNick checks that an IRC
|
||||
// listener connection which takes a nick another user has
|
||||
// given up keeps it when that user's change reaches it
|
||||
// afterwards: what it then sends goes out under the nick its
|
||||
// session holds.
|
||||
func TestRelayNickChangeKeepsTakenNick(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
env := newTestEnv(t)
|
||||
|
||||
bob := env.dial(t)
|
||||
bob.register("bob")
|
||||
bob.sendAndExpect("NICK bob2", " NICK bob2")
|
||||
|
||||
alice := env.dial(t)
|
||||
alice.register("alice")
|
||||
alice.sendAndExpect("NICK bob", " NICK bob")
|
||||
alice.joinAndDrain("#chan")
|
||||
|
||||
bob.joinAndDrain("#chan")
|
||||
|
||||
// Bob's change reaches alice only now, as it does when she
|
||||
// takes his old nick before her connection has passed the
|
||||
// change on. She holds bob now, so it is queued to bob.
|
||||
env.queueMessage(t, "bob", "NICK", "bob", "", []string{"bob2"})
|
||||
|
||||
alice.readUntil(func(l string) bool {
|
||||
return l == ":bob!bob@* NICK bob2"
|
||||
})
|
||||
|
||||
alice.send("PRIVMSG #chan :hi there")
|
||||
|
||||
const want = ":bob!bob@* PRIVMSG #chan :hi there"
|
||||
|
||||
got := bob.readLine()
|
||||
if got != want {
|
||||
t.Errorf("got %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
@@ -6,6 +6,7 @@ import (
|
||||
"log/slog"
|
||||
"net"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"go.uber.org/fx"
|
||||
"sneak.berlin/go/neoirc/internal/broker"
|
||||
@@ -15,6 +16,10 @@ import (
|
||||
"sneak.berlin/go/neoirc/internal/service"
|
||||
)
|
||||
|
||||
// stopTimeout is the longest stop waits for the connections'
|
||||
// cleanup, which ends their sessions.
|
||||
const stopTimeout = 5 * time.Second
|
||||
|
||||
// Params defines the dependencies for creating an IRC
|
||||
// Server.
|
||||
type Params struct {
|
||||
@@ -38,6 +43,19 @@ type Server struct {
|
||||
mu sync.Mutex
|
||||
conns map[*Conn]struct{}
|
||||
cancel context.CancelFunc
|
||||
|
||||
// serving counts the connections whose serve, cleanup
|
||||
// included, has not returned yet.
|
||||
serving sync.WaitGroup
|
||||
|
||||
// pingInterval and pongDeadline are the constants of the
|
||||
// same names, except in tests, which shorten them.
|
||||
pingInterval time.Duration
|
||||
pongDeadline time.Duration
|
||||
|
||||
// resolveHost is the function of the same name, except in
|
||||
// tests, which replace it with one that blocks.
|
||||
resolveHost func(ctx context.Context, addr string) string
|
||||
}
|
||||
|
||||
// New creates a new IRC Server and registers its lifecycle
|
||||
@@ -57,6 +75,11 @@ func New(
|
||||
listener: nil,
|
||||
cancel: nil,
|
||||
mu: sync.Mutex{},
|
||||
serving: sync.WaitGroup{},
|
||||
|
||||
pingInterval: pingInterval,
|
||||
pongDeadline: pongDeadline,
|
||||
resolveHost: resolveHost,
|
||||
}
|
||||
|
||||
listenAddr := params.Config.IRCListenAddr
|
||||
@@ -103,7 +126,10 @@ func (s *Server) start(ctx context.Context, addr string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// stop shuts down the listener and all connections.
|
||||
// stop shuts down the listener and all connections, then
|
||||
// waits up to stopTimeout for every connection's cleanup to
|
||||
// finish, so that their sessions are ended before the
|
||||
// database closes.
|
||||
func (s *Server) stop() {
|
||||
if s.cancel != nil {
|
||||
s.cancel()
|
||||
@@ -118,6 +144,22 @@ func (s *Server) stop() {
|
||||
c.conn.Close() //nolint:errcheck,gosec
|
||||
}
|
||||
s.mu.Unlock()
|
||||
|
||||
done := make(chan struct{})
|
||||
|
||||
go func() {
|
||||
s.serving.Wait()
|
||||
close(done)
|
||||
}()
|
||||
|
||||
select {
|
||||
case <-done:
|
||||
case <-time.After(stopTimeout):
|
||||
s.log.Error(
|
||||
"irc connections not cleaned up before stop timeout",
|
||||
"timeout", stopTimeout,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// acceptLoop accepts new connections.
|
||||
@@ -138,22 +180,39 @@ func (s *Server) acceptLoop(ctx context.Context) {
|
||||
}
|
||||
|
||||
client := newConn(
|
||||
ctx, tcpConn, s.log,
|
||||
tcpConn, s.log,
|
||||
s.database, s.brk, s.cfg, s.svc,
|
||||
)
|
||||
|
||||
s.mu.Lock()
|
||||
|
||||
// stop cancels ctx before it takes s.mu to close the
|
||||
// connections, so a connection accepted while stop
|
||||
// runs is either closed and waited for by stop or
|
||||
// closed here.
|
||||
if ctx.Err() != nil {
|
||||
s.mu.Unlock()
|
||||
tcpConn.Close() //nolint:errcheck,gosec
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
s.conns[client] = struct{}{}
|
||||
s.serving.Add(1)
|
||||
s.mu.Unlock()
|
||||
|
||||
go func() {
|
||||
defer s.serving.Done()
|
||||
defer func() {
|
||||
s.mu.Lock()
|
||||
delete(s.conns, client)
|
||||
s.mu.Unlock()
|
||||
}()
|
||||
|
||||
client.serve(ctx)
|
||||
client.serve(
|
||||
ctx, s.resolveHost,
|
||||
s.pingInterval, s.pongDeadline,
|
||||
)
|
||||
}()
|
||||
}
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,28 @@
|
||||
package server
|
||||
|
||||
import (
|
||||
"net"
|
||||
|
||||
"github.com/go-chi/chi/v5"
|
||||
)
|
||||
|
||||
// NewTestSPAServer creates a Server whose router serves only
|
||||
// the embedded web client.
|
||||
func NewTestSPAServer() *Server {
|
||||
srv := &Server{router: chi.NewRouter()}
|
||||
srv.setupSPA()
|
||||
|
||||
return srv
|
||||
}
|
||||
|
||||
// Listener returns the listener the start hook bound for the
|
||||
// HTTP server.
|
||||
func (srv *Server) Listener() net.Listener {
|
||||
return srv.listener
|
||||
}
|
||||
|
||||
// ServeUntilShutdown runs serveUntilShutdown, which serves the
|
||||
// HTTP server on listener, and returns when it does.
|
||||
func (srv *Server) ServeUntilShutdown(listener net.Listener) {
|
||||
srv.serveUntilShutdown(listener)
|
||||
}
|
||||
@@ -3,6 +3,7 @@ package server
|
||||
import (
|
||||
"io/fs"
|
||||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/neoirc/web"
|
||||
@@ -137,8 +138,10 @@ func (srv *Server) setupSPA() {
|
||||
return
|
||||
}
|
||||
|
||||
// The path is empty, not "/", for a request line such
|
||||
// as "GET http://host HTTP/1.1".
|
||||
fileData, readErr := readFS.ReadFile(
|
||||
request.URL.Path[1:],
|
||||
strings.TrimPrefix(request.URL.Path, "/"),
|
||||
)
|
||||
if readErr != nil || len(fileData) == 0 {
|
||||
indexHTML, indexErr := readFS.ReadFile(
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
package server_test
|
||||
|
||||
import (
|
||||
"io/fs"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/server"
|
||||
"sneak.berlin/go/neoirc/web"
|
||||
)
|
||||
|
||||
// An absolute-form request line with no path, such as
|
||||
// "GET http://example.com HTTP/1.1", leaves URL.Path empty.
|
||||
func TestSPAServesIndexForEmptyPath(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
request := httptest.NewRequestWithContext(
|
||||
t.Context(), http.MethodGet, "http://example.com", nil,
|
||||
)
|
||||
if request.URL.Path != "" {
|
||||
t.Fatalf("URL.Path is %q, want it empty", request.URL.Path)
|
||||
}
|
||||
|
||||
recorder := httptest.NewRecorder()
|
||||
|
||||
server.NewTestSPAServer().ServeHTTP(recorder, request)
|
||||
|
||||
if recorder.Code != http.StatusOK {
|
||||
t.Fatalf("status %d, want %d", recorder.Code, http.StatusOK)
|
||||
}
|
||||
|
||||
indexHTML, err := fs.ReadFile(web.Dist, "dist/index.html")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if recorder.Body.String() != string(indexHTML) {
|
||||
t.Errorf("body is not the index page")
|
||||
}
|
||||
}
|
||||
+49
-49
@@ -6,6 +6,7 @@ import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
"os/signal"
|
||||
@@ -39,18 +40,17 @@ type Params struct {
|
||||
Config *config.Config
|
||||
Middleware *middleware.Middleware
|
||||
Handlers *handlers.Handlers
|
||||
Shutdowner fx.Shutdowner
|
||||
}
|
||||
|
||||
// Server is the main HTTP server.
|
||||
// It manages routing, middleware, and lifecycle.
|
||||
type Server struct {
|
||||
startupTime time.Time
|
||||
exitCode int
|
||||
sentryEnabled bool
|
||||
log *slog.Logger
|
||||
ctx context.Context //nolint:containedctx // signal handling pattern
|
||||
cancelFunc context.CancelFunc
|
||||
httpServer *http.Server
|
||||
listener net.Listener
|
||||
router *chi.Mux
|
||||
params Params
|
||||
mw *middleware.Middleware
|
||||
@@ -69,7 +69,7 @@ func New(
|
||||
}
|
||||
|
||||
lifecycle.Append(fx.Hook{
|
||||
OnStart: func(_ context.Context) error {
|
||||
OnStart: func(ctx context.Context) error {
|
||||
srv.startupTime = time.Now()
|
||||
|
||||
// Build the router before OnStart returns, so srv can
|
||||
@@ -78,13 +78,14 @@ func New(
|
||||
srv.enableSentry()
|
||||
srv.SetupRoutes()
|
||||
|
||||
// The start hook's context ends when the hook
|
||||
// returns; serving must outlive it.
|
||||
go srv.serve() //nolint:contextcheck,gosec // G118
|
||||
// A closed stdout or stderr must not end the process.
|
||||
signal.Ignore(syscall.SIGPIPE)
|
||||
|
||||
return nil
|
||||
return srv.startHTTP(ctx)
|
||||
},
|
||||
OnStop: func(_ context.Context) error {
|
||||
OnStop: func(ctx context.Context) error {
|
||||
srv.cleanShutdown(ctx)
|
||||
|
||||
return nil
|
||||
},
|
||||
})
|
||||
@@ -129,44 +130,15 @@ func (srv *Server) enableSentry() {
|
||||
srv.sentryEnabled = true
|
||||
}
|
||||
|
||||
func (srv *Server) serve() int {
|
||||
srv.ctx, srv.cancelFunc = context.WithCancel(
|
||||
context.Background(),
|
||||
)
|
||||
|
||||
go func() {
|
||||
sigCh := make(chan os.Signal, 1)
|
||||
|
||||
signal.Ignore(syscall.SIGPIPE)
|
||||
signal.Notify(sigCh, os.Interrupt, syscall.SIGTERM)
|
||||
|
||||
sig := <-sigCh
|
||||
|
||||
srv.log.Info("signal received", "signal", sig)
|
||||
|
||||
if srv.cancelFunc != nil {
|
||||
srv.cancelFunc()
|
||||
}
|
||||
}()
|
||||
|
||||
go srv.serveUntilShutdown()
|
||||
|
||||
<-srv.ctx.Done()
|
||||
|
||||
srv.cleanShutdown()
|
||||
|
||||
return srv.exitCode
|
||||
}
|
||||
|
||||
func (srv *Server) cleanupForExit() {
|
||||
srv.log.Info("cleaning up")
|
||||
}
|
||||
|
||||
func (srv *Server) cleanShutdown() {
|
||||
srv.exitCode = 0
|
||||
|
||||
// cleanShutdown stops the HTTP server, waiting up to
|
||||
// shutdownTimeout for the requests in progress to finish.
|
||||
func (srv *Server) cleanShutdown(ctx context.Context) {
|
||||
ctxShutdown, shutdownCancel := context.WithTimeout(
|
||||
context.Background(), shutdownTimeout,
|
||||
ctx, shutdownTimeout,
|
||||
)
|
||||
|
||||
err := srv.httpServer.Shutdown(ctxShutdown)
|
||||
@@ -191,11 +163,25 @@ func (srv *Server) configure() {
|
||||
// Server configuration placeholder.
|
||||
}
|
||||
|
||||
func (srv *Server) serveUntilShutdown() {
|
||||
// startHTTP binds the HTTP listen address, so that a port
|
||||
// that is taken fails startup, then serves the HTTP server
|
||||
// from a new goroutine. srv.httpServer is set before that
|
||||
// goroutine starts and never changes, so it and cleanShutdown
|
||||
// read it without a lock.
|
||||
func (srv *Server) startHTTP(ctx context.Context) error {
|
||||
listenAddr := fmt.Sprintf(
|
||||
":%d", srv.params.Config.Port,
|
||||
)
|
||||
|
||||
var listenConfig net.ListenConfig
|
||||
|
||||
listener, err := listenConfig.Listen(ctx, "tcp", listenAddr)
|
||||
if err != nil {
|
||||
return fmt.Errorf("http listen: %w", err)
|
||||
}
|
||||
|
||||
srv.listener = listener
|
||||
|
||||
srv.httpServer = &http.Server{ //nolint:exhaustruct // optional fields
|
||||
Addr: listenAddr,
|
||||
ReadTimeout: httpReadTimeout,
|
||||
@@ -204,16 +190,30 @@ func (srv *Server) serveUntilShutdown() {
|
||||
Handler: srv,
|
||||
}
|
||||
|
||||
go func() {
|
||||
srv.serveUntilShutdown(listener)
|
||||
}()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// serveUntilShutdown serves the HTTP server on listener until
|
||||
// cleanShutdown stops it. If serving fails before then, it
|
||||
// stops the app with exit code 1.
|
||||
func (srv *Server) serveUntilShutdown(listener net.Listener) {
|
||||
srv.log.Info(
|
||||
"http begin listen", "listenaddr", listenAddr,
|
||||
"http begin listen", "listenaddr", srv.httpServer.Addr,
|
||||
)
|
||||
|
||||
err := srv.httpServer.ListenAndServe()
|
||||
if err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||||
err := srv.httpServer.Serve(listener)
|
||||
if errors.Is(err, http.ErrServerClosed) {
|
||||
return
|
||||
}
|
||||
|
||||
srv.log.Error("listen error", "error", err)
|
||||
|
||||
if srv.cancelFunc != nil {
|
||||
srv.cancelFunc()
|
||||
}
|
||||
err = srv.params.Shutdowner.Shutdown(fx.ExitCode(1))
|
||||
if err != nil {
|
||||
srv.log.Error("shutdown failed", "error", err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,325 @@
|
||||
// Tests use a global viper instance for configuration,
|
||||
// making parallel execution unsafe.
|
||||
//
|
||||
//nolint:paralleltest
|
||||
package server_test
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"go.uber.org/fx"
|
||||
"go.uber.org/fx/fxtest"
|
||||
"sneak.berlin/go/neoirc/internal/broker"
|
||||
"sneak.berlin/go/neoirc/internal/config"
|
||||
"sneak.berlin/go/neoirc/internal/db"
|
||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
||||
"sneak.berlin/go/neoirc/internal/globals"
|
||||
"sneak.berlin/go/neoirc/internal/handlers"
|
||||
"sneak.berlin/go/neoirc/internal/healthcheck"
|
||||
"sneak.berlin/go/neoirc/internal/logger"
|
||||
"sneak.berlin/go/neoirc/internal/middleware"
|
||||
"sneak.berlin/go/neoirc/internal/server"
|
||||
"sneak.berlin/go/neoirc/internal/service"
|
||||
"sneak.berlin/go/neoirc/internal/stats"
|
||||
)
|
||||
|
||||
const (
|
||||
testTimeout = 5 * time.Second
|
||||
|
||||
// checkStep is how often waitUntil checks again.
|
||||
checkStep = 10 * time.Millisecond
|
||||
|
||||
// stopHoldTime is how long a test waits to see that the
|
||||
// app has not stopped.
|
||||
stopHoldTime = 200 * time.Millisecond
|
||||
)
|
||||
|
||||
// TestStopWaitsForRequestInProgress checks that stopping the
|
||||
// app, which runs the stop hook server.New registers, waits
|
||||
// for a long poll the HTTP server is serving to finish, and
|
||||
// that the poll gets its response.
|
||||
func TestStopWaitsForRequestInProgress(t *testing.T) {
|
||||
var srv *server.Server
|
||||
|
||||
app, brk, database := startApp(t, fx.Populate(&srv))
|
||||
|
||||
sessionID, _, token, err := database.CreateSession(
|
||||
t.Context(), "poller", "poller", "", "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("create session: %v", err)
|
||||
}
|
||||
|
||||
tcpAddr, ok := srv.Listener().Addr().(*net.TCPAddr)
|
||||
if !ok {
|
||||
t.Fatalf("listener address %v is not TCP", srv.Listener().Addr())
|
||||
}
|
||||
|
||||
addr := net.JoinHostPort("127.0.0.1", strconv.Itoa(tcpAddr.Port))
|
||||
|
||||
statuses := make(chan int, 1)
|
||||
|
||||
go func() {
|
||||
statuses <- getAuthenticated(
|
||||
t, "http://"+addr+"/api/v1/messages?timeout=30", token,
|
||||
)
|
||||
}()
|
||||
|
||||
waitUntil(t, "the long poll to wait for a message", func() bool {
|
||||
return brk.ListenerCount(sessionID) == 1
|
||||
})
|
||||
|
||||
var stopErr error
|
||||
|
||||
stopped := make(chan struct{})
|
||||
|
||||
go func() {
|
||||
stopErr = app.Stop(t.Context())
|
||||
|
||||
close(stopped)
|
||||
}()
|
||||
|
||||
select {
|
||||
case <-stopped:
|
||||
t.Error("the app stopped while a request was in progress")
|
||||
case <-time.After(stopHoldTime):
|
||||
}
|
||||
|
||||
brk.Notify(sessionID)
|
||||
|
||||
status := <-statuses
|
||||
if status != http.StatusOK {
|
||||
t.Errorf("status %d, want %d", status, http.StatusOK)
|
||||
}
|
||||
|
||||
select {
|
||||
case <-stopped:
|
||||
if stopErr != nil {
|
||||
t.Errorf("stop: %v", stopErr)
|
||||
}
|
||||
case <-time.After(testTimeout):
|
||||
t.Fatal("the app did not stop after the request finished")
|
||||
}
|
||||
}
|
||||
|
||||
// TestStartFailsWhenHTTPPortIsTaken checks that starting the
|
||||
// app, which runs the start hook server.New registers,
|
||||
// returns an error naming the HTTP listen address when
|
||||
// something else is already listening on its port.
|
||||
func TestStartFailsWhenHTTPPortIsTaken(t *testing.T) {
|
||||
var listenConfig net.ListenConfig
|
||||
|
||||
taken, err := listenConfig.Listen(t.Context(), "tcp", ":0")
|
||||
if err != nil {
|
||||
t.Fatalf("listen: %v", err)
|
||||
}
|
||||
|
||||
t.Cleanup(func() { _ = taken.Close() })
|
||||
|
||||
tcpAddr, ok := taken.Addr().(*net.TCPAddr)
|
||||
if !ok {
|
||||
t.Fatalf("listener address %v is not TCP", taken.Addr())
|
||||
}
|
||||
|
||||
app, _, _ := newApp(t, tcpAddr.Port)
|
||||
|
||||
err = app.Start(t.Context())
|
||||
if err == nil {
|
||||
app.RequireStop()
|
||||
t.Fatal("the app started while its HTTP port was taken")
|
||||
}
|
||||
|
||||
listenAddr := fmt.Sprintf(":%d", tcpAddr.Port)
|
||||
if !strings.Contains(err.Error(), listenAddr) {
|
||||
t.Errorf("start error %q does not name %s", err, listenAddr)
|
||||
}
|
||||
}
|
||||
|
||||
// TestServeFailureStopsApp checks that when serving HTTP fails
|
||||
// after the start hook has bound the listen address, the
|
||||
// server stops the app with exit code 1.
|
||||
func TestServeFailureStopsApp(t *testing.T) {
|
||||
var srv *server.Server
|
||||
|
||||
app, _, _ := startApp(t, fx.Populate(&srv))
|
||||
|
||||
shutdowns := app.Wait()
|
||||
|
||||
srv.ServeUntilShutdown(closedListener(t))
|
||||
|
||||
select {
|
||||
case shutdown := <-shutdowns:
|
||||
if shutdown.ExitCode != 1 {
|
||||
t.Errorf("exit code %d, want 1", shutdown.ExitCode)
|
||||
}
|
||||
default:
|
||||
t.Error("the server did not stop the app")
|
||||
}
|
||||
}
|
||||
|
||||
// TestServeAfterStopDoesNotStopApp checks that serving HTTP
|
||||
// after the app has stopped, which ends at once because the
|
||||
// stop hook has shut the HTTP server down, does not stop the
|
||||
// app. Serving ends the same way on every normal stop.
|
||||
func TestServeAfterStopDoesNotStopApp(t *testing.T) {
|
||||
var srv *server.Server
|
||||
|
||||
app, _, _ := startApp(t, fx.Populate(&srv))
|
||||
|
||||
shutdowns := app.Wait()
|
||||
|
||||
app.RequireStop()
|
||||
|
||||
srv.ServeUntilShutdown(closedListener(t))
|
||||
|
||||
select {
|
||||
case shutdown := <-shutdowns:
|
||||
t.Errorf(
|
||||
"the server stopped the app with exit code %d",
|
||||
shutdown.ExitCode,
|
||||
)
|
||||
default:
|
||||
}
|
||||
}
|
||||
|
||||
// startApp starts the app newApp builds, with the HTTP port
|
||||
// set to 0, so the system gives the server a free port.
|
||||
func startApp(
|
||||
t *testing.T,
|
||||
options ...fx.Option,
|
||||
) (*fxtest.App, *broker.Broker, *db.Database) {
|
||||
t.Helper()
|
||||
|
||||
app, brk, database := newApp(t, 0, options...)
|
||||
|
||||
app.RequireStart()
|
||||
|
||||
// Stops the app if the test ends before stopping it.
|
||||
t.Cleanup(app.RequireStop)
|
||||
|
||||
return app, brk, database
|
||||
}
|
||||
|
||||
// newApp builds, without starting it, an app that runs the
|
||||
// server with the dependencies cmd/neoircd gives it, on a
|
||||
// fresh in-memory database, with the HTTP port set to port.
|
||||
// options are added to the app, for a test that needs more
|
||||
// from it than the broker and the database.
|
||||
func newApp(
|
||||
t *testing.T,
|
||||
port int,
|
||||
options ...fx.Option,
|
||||
) (*fxtest.App, *broker.Broker, *db.Database) {
|
||||
t.Helper()
|
||||
|
||||
var (
|
||||
brk *broker.Broker
|
||||
database *db.Database
|
||||
)
|
||||
|
||||
app := fxtest.New(t,
|
||||
fx.Supply(&globals.Globals{
|
||||
Appname: "neoirc-test",
|
||||
Version: "test",
|
||||
StartTime: time.Now(),
|
||||
}),
|
||||
fx.Provide(
|
||||
broker.New,
|
||||
config.New,
|
||||
db.New,
|
||||
handlers.New,
|
||||
healthcheck.New,
|
||||
logger.New,
|
||||
middleware.New,
|
||||
server.New,
|
||||
service.New,
|
||||
stats.New,
|
||||
),
|
||||
fx.Decorate(func(cfg *config.Config) *config.Config {
|
||||
cfg.DBURL = dbtest.NewURL(t)
|
||||
cfg.Port = port
|
||||
|
||||
return cfg
|
||||
}),
|
||||
fx.Invoke(func(*server.Server) {}),
|
||||
fx.Populate(&brk, &database),
|
||||
fx.Options(options...),
|
||||
)
|
||||
|
||||
return app, brk, database
|
||||
}
|
||||
|
||||
// closedListener returns a TCP listener that has already been
|
||||
// closed, so that accepting a connection on it fails.
|
||||
func closedListener(t *testing.T) net.Listener {
|
||||
t.Helper()
|
||||
|
||||
var listenConfig net.ListenConfig
|
||||
|
||||
listener, err := listenConfig.Listen(
|
||||
t.Context(), "tcp", "127.0.0.1:0",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("listen: %v", err)
|
||||
}
|
||||
|
||||
err = listener.Close()
|
||||
if err != nil {
|
||||
t.Fatalf("close listener: %v", err)
|
||||
}
|
||||
|
||||
return listener
|
||||
}
|
||||
|
||||
// waitUntil calls done every checkStep until it returns true,
|
||||
// and fails the test if it does not within testTimeout.
|
||||
func waitUntil(t *testing.T, what string, done func() bool) {
|
||||
t.Helper()
|
||||
|
||||
deadline := time.Now().Add(testTimeout)
|
||||
|
||||
for !done() {
|
||||
if time.Now().After(deadline) {
|
||||
t.Fatalf("timed out waiting for %s", what)
|
||||
}
|
||||
|
||||
time.Sleep(checkStep)
|
||||
}
|
||||
}
|
||||
|
||||
// getAuthenticated sends a GET request to url as the session
|
||||
// whose auth token is token, and returns the response status,
|
||||
// or 0 if there was no response.
|
||||
func getAuthenticated(t *testing.T, url, token string) int {
|
||||
t.Helper()
|
||||
|
||||
request, err := http.NewRequestWithContext(
|
||||
t.Context(), http.MethodGet, url, nil,
|
||||
)
|
||||
if err != nil {
|
||||
t.Errorf("new request: %v", err)
|
||||
|
||||
return 0
|
||||
}
|
||||
|
||||
request.Header.Set("Cookie", "neoirc_auth="+token)
|
||||
|
||||
client := http.Client{Timeout: testTimeout}
|
||||
|
||||
response, err := client.Do(request)
|
||||
if err != nil {
|
||||
t.Errorf("get %s: %v", url, err)
|
||||
|
||||
return 0
|
||||
}
|
||||
|
||||
_ = response.Body.Close()
|
||||
|
||||
return response.StatusCode
|
||||
}
|
||||
+723
-201
File diff suppressed because it is too large
Load Diff
+1041
-30
File diff suppressed because it is too large
Load Diff
@@ -2,10 +2,13 @@ package irc
|
||||
|
||||
// IRC command names (RFC 1459 / RFC 2812).
|
||||
const (
|
||||
CmdAdmin = "ADMIN"
|
||||
CmdAway = "AWAY"
|
||||
CmdInfo = "INFO"
|
||||
CmdInvite = "INVITE"
|
||||
CmdJoin = "JOIN"
|
||||
CmdKick = "KICK"
|
||||
CmdKill = "KILL"
|
||||
CmdList = "LIST"
|
||||
CmdLusers = "LUSERS"
|
||||
CmdMode = "MODE"
|
||||
@@ -20,8 +23,12 @@ const (
|
||||
CmdPong = "PONG"
|
||||
CmdPrivmsg = "PRIVMSG"
|
||||
CmdQuit = "QUIT"
|
||||
CmdTime = "TIME"
|
||||
CmdTopic = "TOPIC"
|
||||
CmdUser = "USER"
|
||||
CmdUserhost = "USERHOST"
|
||||
CmdVersion = "VERSION"
|
||||
CmdWallops = "WALLOPS"
|
||||
CmdWho = "WHO"
|
||||
CmdWhois = "WHOIS"
|
||||
)
|
||||
|
||||
+85
-82
@@ -1,98 +1,101 @@
|
||||
# Message Schemas
|
||||
# Message schemas
|
||||
|
||||
JSON Schema definitions (draft 2020-12) for the neoirc protocol. Messages use
|
||||
**IRC command names and numeric reply codes** (RFC 1459/2812) encoded as JSON
|
||||
over HTTP.
|
||||
This directory holds JSON Schema files (draft 2020-12) for the messages that the
|
||||
neoirc HTTP API carries. `message.json` describes the fields that every message
|
||||
can have. `commands/` has files for some commands. `numerics/` has files for
|
||||
some of the numeric replies. A numeric reply is a server reply named by a
|
||||
three-digit number, such as `001`. `README.md` at the repository root documents
|
||||
the protocol.
|
||||
|
||||
## Envelope
|
||||
The server can also run an IRC listener for ordinary IRC clients. The IRC
|
||||
listener sends plain IRC lines, which these files do not describe.
|
||||
|
||||
Every message is a JSON object with a `command` field. The format maps directly
|
||||
to IRC wire format:
|
||||
## Message fields
|
||||
|
||||
Every message is one JSON object, which `message.json` calls the envelope. These
|
||||
are the fields it can have:
|
||||
|
||||
- `command`: the IRC command name, such as `PRIVMSG`, or the name of a numeric
|
||||
reply, such as `RPL_WELCOME`. Always present.
|
||||
- `code`: the number of a numeric reply, such as `1` for `RPL_WELCOME`. Absent
|
||||
on other messages.
|
||||
- `id`: the message's UUID, a unique ID that the server assigns.
|
||||
- `from`: the sender's nick, or the server name on a numeric reply or a `PONG`.
|
||||
- `to`: the target, such as a channel name starting with `#` or a nick.
|
||||
- `params`: an array of strings with the message's other parameters, in order.
|
||||
`KICK` events and many numeric replies have it. The HTTP API ignores `params`
|
||||
sent by a client.
|
||||
- `body`: an array of strings. It is never a bare string. In a `PRIVMSG` or
|
||||
`NOTICE`, each string is one line of text.
|
||||
- `ts`: the time the server stored the message. It is an RFC 3339 time in UTC,
|
||||
such as `2026-10-27T12:00:00.123Z`.
|
||||
- `meta`: an object of extra data, such as a hashcash stamp in `meta.hashcash`.
|
||||
A hashcash stamp is a short string that takes a computer some work to make. A
|
||||
`PRIVMSG` to a channel with mode `+H` needs one. The HTTP API relays the
|
||||
`meta` of a `PRIVMSG` or `NOTICE` unchanged. It drops the `meta` of every
|
||||
other command.
|
||||
|
||||
Here is one `PRIVMSG` as the IRC listener sends it and as the HTTP API sends it.
|
||||
The JSON leaves out `id`, `ts` and `meta`:
|
||||
|
||||
```
|
||||
IRC: :nick PRIVMSG #channel :hello world
|
||||
JSON: {"command": "PRIVMSG", "from": "nick", "to": "#channel", "body": ["hello world"]}
|
||||
|
||||
IRC: :server 353 nick = #channel :user1 @op1 +voice1
|
||||
JSON: {"command": "353", "to": "nick", "params": ["=", "#channel"], "body": ["user1 @op1 +voice1"]}
|
||||
|
||||
Multiline: {"command": "PRIVMSG", "to": "#ch", "body": ["line 1", "line 2"]}
|
||||
Structured: {"command": "PUBKEY", "body": {"alg": "ed25519", "key": "base64..."}}
|
||||
IRC: :alice!alice@* PRIVMSG #general :hello world
|
||||
JSON: {"command": "PRIVMSG", "from": "alice", "to": "#general", "body": ["hello world"]}
|
||||
```
|
||||
|
||||
Common fields (see `message.json` for full schema):
|
||||
In the JSON, a numeric reply has its name in `command` and its number in `code`.
|
||||
This `353` reply lists the members of `#general`. The JSON again leaves out
|
||||
`id`, `ts` and `meta`:
|
||||
|
||||
| Field | Type | Description |
|
||||
| --------- | --------------- | ---------------------------------------------------- |
|
||||
| `id` | string (uuid) | Server-assigned message UUID |
|
||||
| `command` | string | IRC command or 3-digit numeric code |
|
||||
| `from` | string | Source nick or server name (IRC prefix) |
|
||||
| `to` | string | Target: #channel or nick |
|
||||
| `params` | string[] | Middle parameters (mainly for numerics) |
|
||||
| `body` | array \| object | Structured body — never a raw string (see below) |
|
||||
| `ts` | string | ISO 8601 timestamp (server-assigned, not in raw IRC) |
|
||||
| `meta` | object | Extensible metadata (signatures, hashes, etc.) |
|
||||
```
|
||||
{"command": "RPL_NAMREPLY", "code": 353, "from": "neoirc", "to": "alice",
|
||||
"params": ["=", "#general"], "body": ["@op1!op1@host1 alice!alice@host2"]}
|
||||
```
|
||||
|
||||
**Structured bodies:** `body` is always an array of strings (for text) or an
|
||||
object (for structured data like PUBKEY). Never a raw string. This enables:
|
||||
A `PRIVMSG` whose `body` has two strings is a two-line message:
|
||||
|
||||
- Multiline messages without escape sequences
|
||||
- Deterministic canonicalization via RFC 8785 JCS for signing
|
||||
- Structured data where needed
|
||||
```
|
||||
{"command": "PRIVMSG", "to": "#general", "body": ["line one", "line two"]}
|
||||
```
|
||||
|
||||
## Commands
|
||||
## Files
|
||||
|
||||
IRC commands used for client↔server and server↔server communication.
|
||||
Most command files describe both the message a client sends and the message the
|
||||
server sends. Their field descriptions say where the two differ. The examples in
|
||||
the files leave out `id`, `ts` and `meta`.
|
||||
|
||||
| Command | File | RFC | Description |
|
||||
| --------- | ----------------------- | ----------- | -------------------------- |
|
||||
| `PRIVMSG` | `commands/PRIVMSG.json` | 1459 §4.4.1 | Message to channel or user |
|
||||
| `NOTICE` | `commands/NOTICE.json` | 1459 §4.4.2 | Notice (no auto-reply) |
|
||||
| `JOIN` | `commands/JOIN.json` | 1459 §4.2.1 | Join a channel |
|
||||
| `PART` | `commands/PART.json` | 1459 §4.2.2 | Leave a channel |
|
||||
| `QUIT` | `commands/QUIT.json` | 1459 §4.1.6 | User disconnected |
|
||||
| `NICK` | `commands/NICK.json` | 1459 §4.1.2 | Change nickname |
|
||||
| `TOPIC` | `commands/TOPIC.json` | 1459 §4.2.4 | Get/set channel topic |
|
||||
| `MODE` | `commands/MODE.json` | 1459 §4.2.3 | Set channel/user modes |
|
||||
| `KICK` | `commands/KICK.json` | 1459 §4.2.8 | Kick user from channel |
|
||||
| `PING` | `commands/PING.json` | 1459 §4.6.2 | Keepalive |
|
||||
| `PONG` | `commands/PONG.json` | 1459 §4.6.3 | Keepalive response |
|
||||
| `PUBKEY` | `commands/PUBKEY.json` | (extension) | Announce/relay signing key |
|
||||
Commands, in `commands/`:
|
||||
|
||||
## Numeric Replies
|
||||
- `PRIVMSG.json`: a message to a channel or a user.
|
||||
- `NOTICE.json`: a notice, which is a message that a client must not answer
|
||||
automatically.
|
||||
- `JOIN.json`: joining a channel.
|
||||
- `PART.json`: leaving a channel.
|
||||
- `QUIT.json`: leaving the server.
|
||||
- `NICK.json`: changing nick.
|
||||
- `TOPIC.json`: setting a channel's topic.
|
||||
- `MODE.json`: querying or changing a channel's modes or the user's own modes.
|
||||
- `KICK.json`: a channel operator removing a user from a channel.
|
||||
- `PING.json`: a check that the server still answers.
|
||||
- `PONG.json`: the answer to a `PING`, which is the HTTP response to it.
|
||||
|
||||
Three-digit codes for server responses, per IRC convention.
|
||||
Numeric replies, in `numerics/`:
|
||||
|
||||
### Success / Informational (0xx–3xx)
|
||||
|
||||
| Code | Name | File | Description |
|
||||
| ----- | -------------- | ------------------- | ------------------------------ |
|
||||
| `001` | RPL_WELCOME | `numerics/001.json` | Welcome after session creation |
|
||||
| `002` | RPL_YOURHOST | `numerics/002.json` | Server host info |
|
||||
| `003` | RPL_CREATED | `numerics/003.json` | Server creation date |
|
||||
| `004` | RPL_MYINFO | `numerics/004.json` | Server info and modes |
|
||||
| `322` | RPL_LIST | `numerics/322.json` | Channel list entry |
|
||||
| `323` | RPL_LISTEND | `numerics/323.json` | End of channel list |
|
||||
| `332` | RPL_TOPIC | `numerics/332.json` | Channel topic |
|
||||
| `353` | RPL_NAMREPLY | `numerics/353.json` | Channel member list |
|
||||
| `366` | RPL_ENDOFNAMES | `numerics/366.json` | End of NAMES list |
|
||||
| `372` | RPL_MOTD | `numerics/372.json` | MOTD line |
|
||||
| `375` | RPL_MOTDSTART | `numerics/375.json` | Start of MOTD |
|
||||
| `376` | RPL_ENDOFMOTD | `numerics/376.json` | End of MOTD |
|
||||
|
||||
### Errors (4xx)
|
||||
|
||||
| Code | Name | File | Description |
|
||||
| ----- | -------------------- | ------------------- | ----------------------- |
|
||||
| `401` | ERR_NOSUCHNICK | `numerics/401.json` | No such nick/channel |
|
||||
| `403` | ERR_NOSUCHCHANNEL | `numerics/403.json` | No such channel |
|
||||
| `433` | ERR_NICKNAMEINUSE | `numerics/433.json` | Nickname already in use |
|
||||
| `442` | ERR_NOTONCHANNEL | `numerics/442.json` | Not on that channel |
|
||||
| `482` | ERR_CHANOPRIVSNEEDED | `numerics/482.json` | Not channel operator |
|
||||
|
||||
## Federation (S2S)
|
||||
|
||||
Server-to-server messages use the same command format. Federated servers relay
|
||||
messages with an additional `origin` field in `meta` to track the source server.
|
||||
The PING/PONG commands serve as inter-server keepalives. State sync after link
|
||||
establishment uses a burst of JOIN, NICK, TOPIC, and MODE commands.
|
||||
- `001.json`: `RPL_WELCOME`, which welcomes the user.
|
||||
- `002.json`: `RPL_YOURHOST`, the server's name and version.
|
||||
- `003.json`: `RPL_CREATED`, the date the server last started.
|
||||
- `004.json`: `RPL_MYINFO`, the server's name, its version and its lists of
|
||||
modes.
|
||||
- `322.json`: `RPL_LIST`, one channel in the answer to `LIST`.
|
||||
- `323.json`: `RPL_LISTEND`, the end of the answer to `LIST`.
|
||||
- `332.json`: `RPL_TOPIC`, a channel's topic.
|
||||
- `353.json`: `RPL_NAMREPLY`, a channel's members.
|
||||
- `366.json`: `RPL_ENDOFNAMES`, the end of the member list.
|
||||
- `372.json`: `RPL_MOTD`, one line of the message of the day.
|
||||
- `375.json`: `RPL_MOTDSTART`, the start of the message of the day.
|
||||
- `376.json`: `RPL_ENDOFMOTD`, the end of the message of the day.
|
||||
- `401.json`: `ERR_NOSUCHNICK`, the nick does not exist.
|
||||
- `403.json`: `ERR_NOSUCHCHANNEL`, the channel does not exist.
|
||||
- `433.json`: `ERR_NICKNAMEINUSE`, the nick is taken.
|
||||
- `442.json`: `ERR_NOTONCHANNEL`, the user is not on that channel.
|
||||
- `482.json`: `ERR_CHANOPRIVSNEEDED`, the user is not a channel operator.
|
||||
|
||||
@@ -2,15 +2,25 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/JOIN.json",
|
||||
"title": "JOIN",
|
||||
"description": "Join a channel. C2S: request to join. S2C: notification that a user joined. RFC 1459 §4.2.1.",
|
||||
"description": "Join a channel. A client sends it to join a channel, which the server creates if it does not exist. The server sends it to every member of the channel when a user joins, the new member included. RFC 1459 §4.2.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "JOIN" },
|
||||
"from": { "type": "string", "description": "Nick that joined (S2C)." },
|
||||
"to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" }
|
||||
"from": { "type": "string", "description": "The nick that joined. The server sets it." },
|
||||
"to": {
|
||||
"type": "string",
|
||||
"description": "The channel name: # and then 1 to 63 of a-z, A-Z, 0-9, _ and -. The server adds the # if a client leaves it out.",
|
||||
"pattern": "^#?[a-zA-Z0-9_-]{1,63}$"
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "From a client: the channel key as the first string, which a channel with mode +k needs. From the server: the channel name. After a login, and for GET /api/v1/state?initChannelState=1, the server queues a JOIN for each of the session's channels. That JOIN has an empty body."
|
||||
}
|
||||
},
|
||||
"required": ["command", "to"],
|
||||
"examples": [
|
||||
{ "command": "JOIN", "from": "alice", "to": "#general" }
|
||||
{ "command": "JOIN", "to": "#general" },
|
||||
{ "command": "JOIN", "from": "alice", "to": "#general", "body": ["#general"] }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,28 +2,33 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/KICK.json",
|
||||
"title": "KICK",
|
||||
"description": "Kick a user from a channel. RFC 1459 §4.2.8.",
|
||||
"description": "Remove a user from a channel. A client sends it, and only a channel operator may. The server sends it to every member of the channel, the removed user included. RFC 1459 §4.2.8.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "KICK" },
|
||||
"from": { "type": "string", "description": "Nick that performed the kick." },
|
||||
"to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" },
|
||||
"from": { "type": "string", "description": "The nick that removed the user. The server sets it." },
|
||||
"to": {
|
||||
"type": "string",
|
||||
"description": "The channel name. The server adds the # if a client leaves it out.",
|
||||
"pattern": "^#?[a-zA-Z0-9_-]{1,63}$"
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Kicked nick. e.g. [\"alice\"].",
|
||||
"description": "The removed nick. Only the server sends it.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Optional kick reason.",
|
||||
"maxItems": 1
|
||||
"description": "From a client: the nick to remove, then an optional reason. From the server: the reason, as one string.",
|
||||
"minItems": 1
|
||||
}
|
||||
},
|
||||
"required": ["command", "to", "params"],
|
||||
"required": ["command", "to", "body"],
|
||||
"examples": [
|
||||
{ "command": "KICK", "to": "#general", "body": ["troll", "Behave"] },
|
||||
{ "command": "KICK", "from": "op1", "to": "#general", "params": ["troll"], "body": ["Behave"] }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,28 +2,29 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/MODE.json",
|
||||
"title": "MODE",
|
||||
"description": "Set or query channel/user modes. RFC 1459 §4.2.3.",
|
||||
"description": "Query or change a channel's modes or the user's own modes. A client sends it. The server sends it to every member of the channel when a channel mode changes. A +H or -H sent over the HTTP API is the exception. The server answers it with RPL_CHANNELMODEIS (324) and sends no MODE. RFC 1459 §4.2.3.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "MODE" },
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "Nick that set the mode (S2C only)."
|
||||
"description": "The nick that changed the mode. The server sets it."
|
||||
},
|
||||
"to": {
|
||||
"type": "string",
|
||||
"description": "Channel name.",
|
||||
"pattern": "^#[a-zA-Z0-9_-]+$"
|
||||
"description": "A channel name, which starts with #, or the user's own nick."
|
||||
},
|
||||
"params": {
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Mode string and optional target nick. e.g. [\"+o\", \"alice\"].",
|
||||
"examples": [["+o", "alice"], ["-m"], ["+v", "bob"]]
|
||||
"description": "From a client: the mode change and then its value, as separate strings, such as \"+o\" and \"bob\". A MODE without a body is a query. From the server: the change and its value, as one string, such as \"+o bob\", or as separate strings, such as \"+k\" and \"secret\".",
|
||||
"examples": [["+o", "bob"], ["-m"], ["+o bob"], ["+k", "secret"]]
|
||||
}
|
||||
},
|
||||
"required": ["command", "to", "params"],
|
||||
"required": ["command", "to"],
|
||||
"examples": [
|
||||
{ "command": "MODE", "from": "op1", "to": "#general", "params": ["+o", "alice"] }
|
||||
{ "command": "MODE", "to": "#general", "body": ["+o", "bob"] },
|
||||
{ "command": "MODE", "from": "op1", "to": "#general", "body": ["+o bob"] },
|
||||
{ "command": "MODE", "from": "op1", "to": "#general", "body": ["+k", "secret"] }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,21 +2,21 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/NICK.json",
|
||||
"title": "NICK",
|
||||
"description": "Change nickname. C2S: request new nick. S2C: notification of nick change. RFC 1459 §4.1.2.",
|
||||
"description": "Change nick. A client sends it to change its nick. The server sends it to the user's own clients and to the users who share a channel with the user. RFC 1459 §4.1.2.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "NICK" },
|
||||
"from": { "type": "string", "description": "Old nick (S2C)." },
|
||||
"from": { "type": "string", "description": "The old nick. The server sets it." },
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "New nick (single-element array).",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
"description": "The new nick, as the first string. The server sends one string.",
|
||||
"minItems": 1
|
||||
}
|
||||
},
|
||||
"required": ["command", "body"],
|
||||
"examples": [
|
||||
{ "command": "NICK", "body": ["newnick"] },
|
||||
{ "command": "NICK", "from": "oldnick", "body": ["newnick"] }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,20 +2,21 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/NOTICE.json",
|
||||
"title": "NOTICE",
|
||||
"description": "Send a notice. Like PRIVMSG but must not trigger automatic replies. RFC 1459 §4.4.2.",
|
||||
"description": "A notice: a message to a channel or a user that a client must not answer automatically. The server relays it as it relays a PRIVMSG. A NOTICE to a channel with mode +H needs no hashcash stamp. RFC 1459 §4.4.2.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "NOTICE" },
|
||||
"from": { "type": "string" },
|
||||
"to": { "type": "string", "description": "Target: #channel, nick, or * (global)." },
|
||||
"from": { "type": "string", "description": "The sender's nick. The server sets it." },
|
||||
"to": { "type": "string", "description": "A channel name, which starts with #, or a nick." },
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Notice text lines."
|
||||
"description": "The lines of the notice, one string per line.",
|
||||
"minItems": 1
|
||||
}
|
||||
},
|
||||
"required": ["command", "to", "body"],
|
||||
"examples": [
|
||||
{ "command": "NOTICE", "from": "server.example.com", "to": "*", "body": ["Server restarting in 5 minutes"] }
|
||||
{ "command": "NOTICE", "from": "alice", "to": "#general", "body": ["Back in five minutes"] }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,17 +2,20 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PART.json",
|
||||
"title": "PART",
|
||||
"description": "Leave a channel. C2S: request to leave. S2C: notification that a user left. RFC 1459 §4.2.2.",
|
||||
"description": "Leave a channel. A client sends it to leave. The server sends it to every member of the channel when a user leaves, the leaving user included. RFC 1459 §4.2.2.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "PART" },
|
||||
"from": { "type": "string", "description": "Nick that left (S2C)." },
|
||||
"to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" },
|
||||
"from": { "type": "string", "description": "The nick that left. The server sets it." },
|
||||
"to": {
|
||||
"type": "string",
|
||||
"description": "The channel name. The server adds the # if a client leaves it out.",
|
||||
"pattern": "^#?[a-zA-Z0-9_-]{1,63}$"
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Optional part reason.",
|
||||
"maxItems": 1
|
||||
"description": "The reason for leaving. A client may send one as the first string. The server always sends one string, which is empty when no reason was given."
|
||||
}
|
||||
},
|
||||
"required": ["command", "to"],
|
||||
|
||||
@@ -2,19 +2,13 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PING.json",
|
||||
"title": "PING",
|
||||
"description": "Keepalive. C2S or S2S. Server responds with PONG. RFC 1459 §4.6.2.",
|
||||
"description": "A check that the server still answers. A client sends it. The server ignores every field but 'command'. Its answer is a PONG in the HTTP response. RFC 1459 §4.6.2.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "PING" },
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Opaque token to be echoed in PONG (single-element array).",
|
||||
"maxItems": 1
|
||||
}
|
||||
"command": { "const": "PING" }
|
||||
},
|
||||
"required": ["command"],
|
||||
"examples": [
|
||||
{ "command": "PING", "body": ["1707580000"] }
|
||||
{ "command": "PING" }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,20 +2,14 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PONG.json",
|
||||
"title": "PONG",
|
||||
"description": "Keepalive response. S2C or S2S. RFC 1459 §4.6.3.",
|
||||
"description": "The answer to a PING. The server sends it as the HTTP response to the PING, with only 'command' and 'from'. A client's PONG gets ERR_UNKNOWNCOMMAND (421). RFC 1459 §4.6.3.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "PONG" },
|
||||
"from": { "type": "string", "description": "Responding server name." },
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Echoed token from PING (single-element array).",
|
||||
"maxItems": 1
|
||||
}
|
||||
"from": { "type": "string", "description": "The server name." }
|
||||
},
|
||||
"required": ["command"],
|
||||
"required": ["command", "from"],
|
||||
"examples": [
|
||||
{ "command": "PONG", "from": "server.example.com", "body": ["1707580000"] }
|
||||
{ "command": "PONG", "from": "neoirc" }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,16 +2,16 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PRIVMSG.json",
|
||||
"title": "PRIVMSG",
|
||||
"description": "Send a message to a channel or user. C2S: client sends to server. S2C: server relays to recipients. RFC 1459 §4.4.1.",
|
||||
"description": "A message to a channel or a user. A client sends it. The server relays it to every member of the channel, or to the user, and to the sender's own clients. RFC 1459 §4.4.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "PRIVMSG" },
|
||||
"from": { "type": "string", "description": "Sender nick (set by server on relay)." },
|
||||
"to": { "type": "string", "description": "Target: #channel or nick.", "examples": ["#general", "alice"] },
|
||||
"from": { "type": "string", "description": "The sender's nick. The server sets it." },
|
||||
"to": { "type": "string", "description": "A channel name, which starts with #, or a nick.", "examples": ["#general", "alice"] },
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Message lines. One string per line.",
|
||||
"description": "The lines of the message, one string per line.",
|
||||
"minItems": 1
|
||||
}
|
||||
},
|
||||
@@ -19,6 +19,6 @@
|
||||
"examples": [
|
||||
{ "command": "PRIVMSG", "from": "bob", "to": "#general", "body": ["hello world"] },
|
||||
{ "command": "PRIVMSG", "from": "bob", "to": "#general", "body": ["line one", "line two"] },
|
||||
{ "command": "PRIVMSG", "from": "bob", "to": "alice", "body": ["hey"], "meta": { "sig": "base64...", "alg": "ed25519" } }
|
||||
{ "command": "PRIVMSG", "from": "bob", "to": "alice", "body": ["hey"] }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PUBKEY.json",
|
||||
"title": "PUBKEY",
|
||||
"description": "Announce or relay a user's public signing key. C2S: client announces key to channel or server. S2C: server relays to channel members. Protocol extension (not in RFC 1459). Body is a structured object (not an array) containing the key material.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "PUBKEY" },
|
||||
"from": { "type": "string", "description": "Nick announcing the key (set by server on relay)." },
|
||||
"to": {
|
||||
"type": "string",
|
||||
"description": "Target: #channel to announce to channel members, or omit for server-wide announcement."
|
||||
},
|
||||
"body": {
|
||||
"type": "object",
|
||||
"description": "Key material.",
|
||||
"properties": {
|
||||
"alg": {
|
||||
"type": "string",
|
||||
"description": "Key algorithm.",
|
||||
"enum": ["ed25519"]
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "Base64-encoded public key."
|
||||
}
|
||||
},
|
||||
"required": ["alg", "key"],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": ["command", "body"],
|
||||
"examples": [
|
||||
{ "command": "PUBKEY", "from": "alice", "body": { "alg": "ed25519", "key": "base64-encoded-pubkey" } },
|
||||
{ "command": "PUBKEY", "from": "alice", "to": "#general", "body": { "alg": "ed25519", "key": "base64-encoded-pubkey" } }
|
||||
]
|
||||
}
|
||||
@@ -2,20 +2,20 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/QUIT.json",
|
||||
"title": "QUIT",
|
||||
"description": "User disconnected. S2C only. RFC 1459 §4.1.6.",
|
||||
"description": "A user left the server. A client sends it to end its session. The server sends it to the users who shared a channel with the user who left. RFC 1459 §4.1.6.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "QUIT" },
|
||||
"from": { "type": "string", "description": "Nick that quit." },
|
||||
"from": { "type": "string", "description": "The nick that quit. The server sets it." },
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Optional quit reason.",
|
||||
"maxItems": 1
|
||||
"description": "The reason for leaving. A client may send one as the first string, and the server uses 'Client quit' when it does not. The server always sends one string."
|
||||
}
|
||||
},
|
||||
"required": ["command", "from"],
|
||||
"required": ["command"],
|
||||
"examples": [
|
||||
{ "command": "QUIT", "from": "alice", "body": ["Connection reset"] }
|
||||
{ "command": "QUIT", "body": ["Gone for the day"] },
|
||||
{ "command": "QUIT", "from": "alice", "body": ["Connection closed"] }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,20 +2,24 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/TOPIC.json",
|
||||
"title": "TOPIC",
|
||||
"description": "Get or set channel topic. C2S: set topic (body present) or query (body absent). S2C: topic change notification. RFC 1459 §4.2.4.",
|
||||
"description": "Set a channel's topic. A client sends it to set the topic. The server sends it to every member of the channel when the topic changes. RFC 1459 §4.2.4.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": { "const": "TOPIC" },
|
||||
"from": { "type": "string", "description": "Nick that changed the topic (S2C)." },
|
||||
"to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" },
|
||||
"from": { "type": "string", "description": "The nick that set the topic. The server sets it." },
|
||||
"to": {
|
||||
"type": "string",
|
||||
"description": "The channel name. The server adds the # if a client leaves it out.",
|
||||
"pattern": "^#?[a-zA-Z0-9_-]{1,63}$"
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "New topic text (single-element array). Empty array clears the topic.",
|
||||
"maxItems": 1
|
||||
"description": "The new topic. The server joins a client's strings with spaces, and sends the topic as one string. [\"\"] clears the topic.",
|
||||
"minItems": 1
|
||||
}
|
||||
},
|
||||
"required": ["command", "to"],
|
||||
"required": ["command", "to", "body"],
|
||||
"examples": [
|
||||
{ "command": "TOPIC", "from": "alice", "to": "#general", "body": ["Welcome to the channel"] }
|
||||
]
|
||||
|
||||
+18
-30
@@ -2,67 +2,55 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/message.json",
|
||||
"title": "IRC Message Envelope",
|
||||
"description": "Base envelope for all messages. Mirrors IRC wire format (RFC 1459/2812) encoded as JSON over HTTP. The 'command' field carries either an IRC command name (PRIVMSG, JOIN, etc.) or a three-digit numeric reply code (001, 353, 433, etc.).",
|
||||
"description": "Every message in the HTTP API is one JSON object with these fields. Only 'command' is always present.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"format": "uuid",
|
||||
"description": "Server-assigned message UUID. Present on all server-originated messages."
|
||||
"description": "The message's UUID, which the server assigns. Present on every message the server queues for a client."
|
||||
},
|
||||
"command": {
|
||||
"type": "string",
|
||||
"description": "IRC command name (PRIVMSG, JOIN, NICK, etc.) or three-digit numeric reply code (001, 353, 433, etc.).",
|
||||
"examples": ["PRIVMSG", "JOIN", "001", "353", "433"]
|
||||
"description": "An IRC command name, such as PRIVMSG, or the name of a numeric reply, such as RPL_WELCOME. The server reads a client's command in any case and sends it in upper case.",
|
||||
"examples": ["PRIVMSG", "JOIN", "RPL_WELCOME", "ERR_NICKNAMEINUSE"]
|
||||
},
|
||||
"code": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 999,
|
||||
"description": "The number of a numeric reply, such as 1 for RPL_WELCOME. Absent on other messages."
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "Source — nick for user messages, server name for server messages. Equivalent to IRC prefix."
|
||||
"description": "The sender's nick, or the server name on a numeric reply or a PONG. The server sets it and ignores it from a client."
|
||||
},
|
||||
"to": {
|
||||
"type": "string",
|
||||
"description": "Target — channel (#name) or nick. Equivalent to first IRC parameter for most commands."
|
||||
"description": "The target: a channel name, such as #general, or a nick. A WALLOPS has * here."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Additional parameters (used primarily by numeric replies). Equivalent to IRC middle parameters."
|
||||
"description": "The message's other parameters, in order. KICK events and many numeric replies have it. The server ignores it from a client."
|
||||
},
|
||||
"body": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"description": "Array of strings (one per line for text messages)."
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"description": "Structured data (e.g. PUBKEY key material).",
|
||||
"additionalProperties": true
|
||||
}
|
||||
],
|
||||
"description": "Message body. MUST be an array or object, never a raw string. Arrays represent lines of text; objects carry structured data. This enables deterministic canonicalization (RFC 8785 JCS) for signing."
|
||||
"description": "An array of strings, never a bare string. In a PRIVMSG or NOTICE, each string is one line of text."
|
||||
},
|
||||
"ts": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Server-assigned timestamp (ISO 8601). Not present in original IRC; added for HTTP transport."
|
||||
"description": "The time the server stored the message, as an RFC 3339 time in UTC."
|
||||
},
|
||||
"meta": {
|
||||
"type": "object",
|
||||
"description": "Extensible metadata. Used for signatures (meta.sig, meta.alg), hashes (meta.hash), and client extensions.",
|
||||
"description": "An object of extra data. Every message the server queues for a client has meta, which is {} when there is none. The server keeps a client's meta only on a PRIVMSG or NOTICE, and relays it unchanged.",
|
||||
"properties": {
|
||||
"sig": {
|
||||
"hashcash": {
|
||||
"type": "string",
|
||||
"description": "Base64-encoded cryptographic signature over the canonical message form."
|
||||
},
|
||||
"alg": {
|
||||
"type": "string",
|
||||
"description": "Signature algorithm (e.g. 'ed25519')."
|
||||
},
|
||||
"hash": {
|
||||
"type": "string",
|
||||
"description": "Hash of the canonical message form (e.g. 'sha256:base64...')."
|
||||
"description": "A hashcash stamp. A PRIVMSG to a channel with mode +H needs one."
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
|
||||
@@ -2,32 +2,45 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/001.json",
|
||||
"title": "001 RPL_WELCOME",
|
||||
"description": "Welcome message sent after successful session creation. RFC 2812 \u00a75.1.",
|
||||
"description": "Welcomes the user. Sent after a session is created, after a login, and in answer to MOTD. RFC 2812 §5.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "001"
|
||||
"const": "RPL_WELCOME"
|
||||
},
|
||||
"code": {
|
||||
"const": 1
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string",
|
||||
"description": "Target nick."
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Welcome text lines."
|
||||
"description": "One string: 'Welcome to the network, ' and the user's nick.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "001",
|
||||
"command": "RPL_WELCOME",
|
||||
"code": 1,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"body": [
|
||||
"Welcome to the network, alice"
|
||||
|
||||
@@ -2,34 +2,48 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/002.json",
|
||||
"title": "002 RPL_YOURHOST",
|
||||
"description": "Server host info sent after session creation. RFC 2812 \u00a75.1.",
|
||||
"description": "The server's name and version. Sent right after RPL_WELCOME. RFC 2812 §5.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "002"
|
||||
"const": "RPL_YOURHOST"
|
||||
},
|
||||
"code": {
|
||||
"const": 2
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Host info lines."
|
||||
"description": "One string: 'Your host is ', the server name, ', running version ' and the version.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "002",
|
||||
"command": "RPL_YOURHOST",
|
||||
"code": 2,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"body": [
|
||||
"Your host is neoirc.example.com, running version 0.1.0"
|
||||
"Your host is neoirc, running version dev"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
@@ -2,31 +2,45 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/003.json",
|
||||
"title": "003 RPL_CREATED",
|
||||
"description": "Server creation date. RFC 2812 \u00a75.1.",
|
||||
"description": "The date the server last started. Sent right after RPL_YOURHOST. RFC 2812 §5.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "003"
|
||||
"const": "RPL_CREATED"
|
||||
},
|
||||
"code": {
|
||||
"const": 3
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Text lines."
|
||||
"description": "One string: 'This server was created ' and the start date as YYYY-MM-DD.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "003",
|
||||
"command": "RPL_CREATED",
|
||||
"code": 3,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"body": [
|
||||
"This server was created 2026-02-01"
|
||||
|
||||
+37
-10
@@ -2,37 +2,64 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/004.json",
|
||||
"title": "004 RPL_MYINFO",
|
||||
"description": "Server info (name, version, available modes). RFC 2812 \u00a75.1.",
|
||||
"description": "The server's name, its version, and its lists of user and channel modes. Sent right after RPL_CREATED. RFC 2812 §5.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "004"
|
||||
"const": "RPL_MYINFO"
|
||||
},
|
||||
"code": {
|
||||
"const": 4
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "[server_name, version, user_modes, channel_modes]."
|
||||
"description": "The server name, the version, the user modes 'ow' and the channel modes 'Hbiklmnostv'.",
|
||||
"minItems": 4,
|
||||
"maxItems": 4
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "One empty string.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"params"
|
||||
"params",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "004",
|
||||
"command": "RPL_MYINFO",
|
||||
"code": 4,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": [
|
||||
"neoirc.example.com",
|
||||
"0.1.0",
|
||||
"o",
|
||||
"imnst+ov"
|
||||
"neoirc",
|
||||
"dev",
|
||||
"ow",
|
||||
"Hbiklmnostv"
|
||||
],
|
||||
"body": [
|
||||
""
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
@@ -2,38 +2,55 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/322.json",
|
||||
"title": "322 RPL_LIST",
|
||||
"description": "Channel list entry. One per channel in response to LIST. RFC 1459 \u00a76.2.",
|
||||
"description": "One channel in the answer to LIST. The answer has one per channel, except a secret channel, one with mode +s, that the user is not on. RFC 1459 §6.2.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "322"
|
||||
"const": "RPL_LIST"
|
||||
},
|
||||
"code": {
|
||||
"const": 322
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "[channel, visible_count]."
|
||||
"description": "The channel name and its number of members.",
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Channel topic."
|
||||
"description": "One string: the channel's topic, empty when it has none.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"params"
|
||||
"params",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "322",
|
||||
"command": "RPL_LIST",
|
||||
"code": 322,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": [
|
||||
"#general",
|
||||
|
||||
@@ -2,26 +2,49 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/323.json",
|
||||
"title": "323 RPL_LISTEND",
|
||||
"description": "End of channel list. RFC 1459 \u00a76.2.",
|
||||
"description": "The end of the answer to LIST. RFC 1459 §6.2.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "323"
|
||||
"const": "RPL_LISTEND"
|
||||
},
|
||||
"code": {
|
||||
"const": 323
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "End of /LIST",
|
||||
"description": "One string: 'End of /LIST'.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"to"
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "RPL_LISTEND",
|
||||
"code": 323,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"body": [
|
||||
"End of /LIST"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,39 +2,55 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/332.json",
|
||||
"title": "332 RPL_TOPIC",
|
||||
"description": "Channel topic (sent on JOIN or TOPIC query). RFC 1459 \u00a76.2.",
|
||||
"description": "A channel's topic. Sent to a client after it sets the topic, and after it joins a channel that has one. Also sent for each of a session's channels that has one after a login, and for GET /api/v1/state?initChannelState=1. RFC 1459 §6.2.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "332"
|
||||
"const": "RPL_TOPIC"
|
||||
},
|
||||
"code": {
|
||||
"const": 332
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "[channel]."
|
||||
"description": "The channel name.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Topic text."
|
||||
"description": "One string: the topic.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"params",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "332",
|
||||
"command": "RPL_TOPIC",
|
||||
"code": 332,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": [
|
||||
"#general"
|
||||
|
||||
@@ -2,46 +2,62 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/353.json",
|
||||
"title": "353 RPL_NAMREPLY",
|
||||
"description": "Channel member list. Sent on JOIN or NAMES query. RFC 1459 \u00a76.2.",
|
||||
"description": "A channel's members. Sent to a client after it joins a channel, and in answer to NAMES. Also sent for each of a session's channels after a login, and for GET /api/v1/state?initChannelState=1. RFC 1459 §6.2.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "353"
|
||||
"const": "RPL_NAMREPLY"
|
||||
},
|
||||
"code": {
|
||||
"const": 353
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "[channel_type, channel]. channel_type: = (public), * (private), @ (secret)."
|
||||
"description": "'=' and the channel name. The server always sends '='.",
|
||||
"minItems": 2,
|
||||
"maxItems": 2
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Space-separated list of nicks. Prefixed with @ for ops, + for voiced."
|
||||
"description": "One string: the members as nick!user@host, separated by spaces. '@' comes before a channel operator and '+' before a voiced member. The host is '*' when the server does not know it.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"params",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "353",
|
||||
"command": "RPL_NAMREPLY",
|
||||
"code": 353,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": [
|
||||
"=",
|
||||
"#general"
|
||||
],
|
||||
"body": [
|
||||
"@op1 alice bob +voiced1"
|
||||
"@op1!op1@host1 alice!alice@host2 +bob!bob@host3"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
@@ -2,34 +2,62 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/366.json",
|
||||
"title": "366 RPL_ENDOFNAMES",
|
||||
"description": "End of NAMES list. RFC 1459 \u00a76.2.",
|
||||
"description": "The end of a channel's member list. It comes after the RPL_NAMREPLY for the channel. RFC 1459 §6.2.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "366"
|
||||
"const": "RPL_ENDOFNAMES"
|
||||
},
|
||||
"code": {
|
||||
"const": 366
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "[channel]."
|
||||
"description": "The channel name.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "End of /NAMES list",
|
||||
"description": "One string: 'End of /NAMES list'.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"params"
|
||||
"params",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "RPL_ENDOFNAMES",
|
||||
"code": 366,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": [
|
||||
"#general"
|
||||
],
|
||||
"body": [
|
||||
"End of /NAMES list"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,31 +2,45 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/372.json",
|
||||
"title": "372 RPL_MOTD",
|
||||
"description": "MOTD line. One message per line of the MOTD. RFC 2812 \u00a75.1.",
|
||||
"description": "One line of the message of the day. The server sends one per line, after RPL_MOTDSTART. RFC 2812 §5.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "372"
|
||||
"const": "RPL_MOTD"
|
||||
},
|
||||
"code": {
|
||||
"const": 372
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "MOTD line text (prefixed with '- ')."
|
||||
"description": "One string: '- ' and the line.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "372",
|
||||
"command": "RPL_MOTD",
|
||||
"code": 372,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"body": [
|
||||
"- Welcome to our server!"
|
||||
|
||||
@@ -2,25 +2,49 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/375.json",
|
||||
"title": "375 RPL_MOTDSTART",
|
||||
"description": "Start of MOTD. RFC 2812 \u00a75.1.",
|
||||
"description": "The start of the message of the day. Sent after RPL_LUSERME (255) when the server has a message of the day. RFC 2812 §5.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "375"
|
||||
"const": "RPL_MOTDSTART"
|
||||
},
|
||||
"code": {
|
||||
"const": 375
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Text lines."
|
||||
"description": "One string: '- ', the server name and ' Message of the Day -'.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"to"
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "RPL_MOTDSTART",
|
||||
"code": 375,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"body": [
|
||||
"- neoirc Message of the Day -"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,26 +2,49 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/376.json",
|
||||
"title": "376 RPL_ENDOFMOTD",
|
||||
"description": "End of MOTD. RFC 2812 \u00a75.1.",
|
||||
"description": "The end of the message of the day. RFC 2812 §5.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "376"
|
||||
"const": "RPL_ENDOFMOTD"
|
||||
},
|
||||
"code": {
|
||||
"const": 376
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "End of /MOTD command",
|
||||
"description": "One string: 'End of /MOTD command.'.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"to"
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "RPL_ENDOFMOTD",
|
||||
"code": 376,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"body": [
|
||||
"End of /MOTD command."
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,45 +2,61 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/401.json",
|
||||
"title": "401 ERR_NOSUCHNICK",
|
||||
"description": "No such nick/channel. RFC 1459 \u00a76.1.",
|
||||
"description": "No user has that nick. RFC 1459 §6.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "401"
|
||||
"const": "ERR_NOSUCHNICK"
|
||||
},
|
||||
"code": {
|
||||
"const": 401
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "[target_nick]."
|
||||
"description": "The nick that was not found.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "No such nick/channel",
|
||||
"description": "One string: 'No such nick' in answer to a PRIVMSG or NOTICE, and 'No such nick/channel' in answer to anything else.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"params"
|
||||
"params",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "401",
|
||||
"command": "ERR_NOSUCHNICK",
|
||||
"code": 401,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": [
|
||||
"bob"
|
||||
],
|
||||
"body": [
|
||||
"No such nick/channel"
|
||||
"No such nick"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
@@ -2,39 +2,55 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/403.json",
|
||||
"title": "403 ERR_NOSUCHCHANNEL",
|
||||
"description": "No such channel. RFC 1459 \u00a76.1.",
|
||||
"description": "No channel has that name. A JOIN with a channel name that the server does not allow gets it too. RFC 1459 §6.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "403"
|
||||
"const": "ERR_NOSUCHCHANNEL"
|
||||
},
|
||||
"code": {
|
||||
"const": 403
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "[channel_name]."
|
||||
"description": "The channel name.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "No such channel",
|
||||
"description": "One string: 'No such channel'.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"params"
|
||||
"params",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "403",
|
||||
"command": "ERR_NOSUCHCHANNEL",
|
||||
"code": 403,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": [
|
||||
"#nonexistent"
|
||||
|
||||
@@ -2,42 +2,58 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/433.json",
|
||||
"title": "433 ERR_NICKNAMEINUSE",
|
||||
"description": "Nickname is already in use. RFC 1459 \u00a76.1.",
|
||||
"description": "Another user has the nick. Sent in answer to a NICK. RFC 1459 §6.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "433"
|
||||
"const": "ERR_NICKNAMEINUSE"
|
||||
},
|
||||
"code": {
|
||||
"const": 433
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick, which has not changed."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "[requested_nick]."
|
||||
"description": "The nick that was asked for.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Nickname is already in use",
|
||||
"description": "One string: 'Nickname is already in use'.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"params"
|
||||
"params",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "433",
|
||||
"to": "*",
|
||||
"command": "ERR_NICKNAMEINUSE",
|
||||
"code": 433,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": [
|
||||
"alice"
|
||||
"bob"
|
||||
],
|
||||
"body": [
|
||||
"Nickname is already in use"
|
||||
|
||||
@@ -2,34 +2,62 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/442.json",
|
||||
"title": "442 ERR_NOTONCHANNEL",
|
||||
"description": "You're not on that channel. RFC 1459 \u00a76.1.",
|
||||
"description": "The user is not on that channel. RFC 1459 §6.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "442"
|
||||
"const": "ERR_NOTONCHANNEL"
|
||||
},
|
||||
"code": {
|
||||
"const": 442
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "[channel]."
|
||||
"description": "The channel name.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "You're not on that channel",
|
||||
"description": "One string: 'You're not on that channel'.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"params"
|
||||
"params",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "ERR_NOTONCHANNEL",
|
||||
"code": 442,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": [
|
||||
"#general"
|
||||
],
|
||||
"body": [
|
||||
"You're not on that channel"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,34 +2,62 @@
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/482.json",
|
||||
"title": "482 ERR_CHANOPRIVSNEEDED",
|
||||
"description": "You're not channel operator. RFC 1459 \u00a76.1.",
|
||||
"description": "The user is not a channel operator, and the command needs one. RFC 1459 §6.1.",
|
||||
"$ref": "../message.json",
|
||||
"properties": {
|
||||
"command": {
|
||||
"const": "482"
|
||||
"const": "ERR_CHANOPRIVSNEEDED"
|
||||
},
|
||||
"code": {
|
||||
"const": 482
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The server name."
|
||||
},
|
||||
"to": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"description": "The user's nick."
|
||||
},
|
||||
"params": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "[channel]."
|
||||
"description": "The channel name.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
},
|
||||
"body": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "You're not channel operator",
|
||||
"description": "One string: 'You're not channel operator'.",
|
||||
"minItems": 1,
|
||||
"maxItems": 1
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"command",
|
||||
"code",
|
||||
"from",
|
||||
"to",
|
||||
"params"
|
||||
"params",
|
||||
"body"
|
||||
],
|
||||
"examples": [
|
||||
{
|
||||
"command": "ERR_CHANOPRIVSNEEDED",
|
||||
"code": 482,
|
||||
"from": "neoirc",
|
||||
"to": "alice",
|
||||
"params": [
|
||||
"#general"
|
||||
],
|
||||
"body": [
|
||||
"You're not channel operator"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
+233
-110
@@ -7,6 +7,11 @@ const RECONNECT_DELAY = 3000;
|
||||
const MEMBER_REFRESH_INTERVAL = 10000;
|
||||
const ACTION_PREFIX = "\x01ACTION ";
|
||||
const ACTION_SUFFIX = "\x01";
|
||||
// SERVER_TAB is the Server tab's name, under which its messages and
|
||||
// unread count are stored. No nick or channel name can contain *, so a
|
||||
// user with the nick Server gets a direct-message tab of its own. The
|
||||
// tab bar labels this tab Server.
|
||||
const SERVER_TAB = "*server*";
|
||||
|
||||
// Hashcash proof-of-work helpers using Web Crypto API.
|
||||
|
||||
@@ -58,13 +63,13 @@ async function mintHashcash(bits, resource) {
|
||||
}
|
||||
}
|
||||
|
||||
// Requests are authenticated by the auth cookie, which the browser
|
||||
// sends on its own.
|
||||
function api(path, opts = {}) {
|
||||
const token = localStorage.getItem("neoirc_token");
|
||||
const headers = {
|
||||
"Content-Type": "application/json",
|
||||
...(opts.headers || {}),
|
||||
};
|
||||
if (token) headers["Authorization"] = `Bearer ${token}`;
|
||||
const { signal, ...rest } = opts;
|
||||
|
||||
return fetch(API + path, { ...rest, headers, signal }).then(async (r) => {
|
||||
@@ -122,12 +127,11 @@ function LoginScreen({ onLogin }) {
|
||||
if (s.name) hashcashResourceRef.current = s.name;
|
||||
})
|
||||
.catch(() => {});
|
||||
const saved = localStorage.getItem("neoirc_token");
|
||||
if (saved) {
|
||||
// Resume the session if the browser still holds a valid auth
|
||||
// cookie; a 401 leaves the login form up.
|
||||
api("/state?initChannelState=1")
|
||||
.then((u) => onLogin(u.nick, true))
|
||||
.catch(() => localStorage.removeItem("neoirc_token"));
|
||||
}
|
||||
.catch(() => {});
|
||||
inputRef.current?.focus();
|
||||
}, []);
|
||||
|
||||
@@ -152,7 +156,6 @@ function LoginScreen({ onLogin }) {
|
||||
method: "POST",
|
||||
body: JSON.stringify(reqBody),
|
||||
});
|
||||
localStorage.setItem("neoirc_token", res.token);
|
||||
onLogin(res.nick);
|
||||
} catch (err) {
|
||||
setError(err.data?.error || "Connection failed");
|
||||
@@ -227,10 +230,9 @@ function UserList({ members, onNickClick }) {
|
||||
const regular = [];
|
||||
|
||||
for (const m of members) {
|
||||
const mode = m.mode || "";
|
||||
if (mode === "o") {
|
||||
if (m.isOperator) {
|
||||
ops.push(m);
|
||||
} else if (mode === "v") {
|
||||
} else if (m.isVoiced) {
|
||||
voiced.push(m);
|
||||
} else {
|
||||
regular.push(m);
|
||||
@@ -273,9 +275,9 @@ function UserList({ members, onNickClick }) {
|
||||
function App() {
|
||||
const [loggedIn, setLoggedIn] = useState(false);
|
||||
const [nick, setNick] = useState("");
|
||||
const [tabs, setTabs] = useState([{ type: "server", name: "Server" }]);
|
||||
const [tabs, setTabs] = useState([{ type: "server", name: SERVER_TAB }]);
|
||||
const [activeTab, setActiveTab] = useState(0);
|
||||
const [messages, setMessages] = useState({ Server: [] });
|
||||
const [messages, setMessages] = useState({ [SERVER_TAB]: [] });
|
||||
const [members, setMembers] = useState({});
|
||||
const [topics, setTopics] = useState({});
|
||||
const [unread, setUnread] = useState({});
|
||||
@@ -303,11 +305,14 @@ function App() {
|
||||
nickRef.current = nick;
|
||||
}, [nick]);
|
||||
|
||||
// Persist joined channels.
|
||||
// Persist joined channels, once logged in: before then only the
|
||||
// Server tab exists, and writing would erase the saved channels
|
||||
// that onLogin rejoins.
|
||||
useEffect(() => {
|
||||
if (!loggedIn) return;
|
||||
const channels = tabs.filter((t) => t.type === "channel").map((t) => t.name);
|
||||
localStorage.setItem("neoirc_channels", JSON.stringify(channels));
|
||||
}, [tabs]);
|
||||
}, [loggedIn, tabs]);
|
||||
|
||||
// Clear unread on tab switch.
|
||||
useEffect(() => {
|
||||
@@ -355,6 +360,26 @@ function App() {
|
||||
.catch(() => {});
|
||||
}, []);
|
||||
|
||||
// removeChannelTab closes a channel's tab. The tab the user was
|
||||
// reading stays active, found by its name; when it was the closed tab,
|
||||
// the Server tab shows.
|
||||
const removeChannelTab = useCallback((name) => {
|
||||
setTabs((prev) => {
|
||||
const remaining = prev.filter(
|
||||
(t) => !(t.type === "channel" && t.name === name),
|
||||
);
|
||||
// Preact runs this update at once, on the newest active tab.
|
||||
setActiveTab((active) => {
|
||||
const reading = prev[active]?.name;
|
||||
const idx = remaining.findIndex((t) => t.name === reading);
|
||||
|
||||
return idx >= 0 ? idx : 0;
|
||||
});
|
||||
|
||||
return remaining;
|
||||
});
|
||||
}, []);
|
||||
|
||||
const processMessage = useCallback(
|
||||
(msg) => {
|
||||
const body = Array.isArray(msg.body) ? msg.body.join("\n") : "";
|
||||
@@ -366,7 +391,9 @@ function App() {
|
||||
command: msg.command,
|
||||
};
|
||||
|
||||
switch (msg.command) {
|
||||
// A numeric reply carries its number in `code` and its name in
|
||||
// `command`; other messages have no `code`.
|
||||
switch (msg.code || msg.command) {
|
||||
case "PRIVMSG":
|
||||
case "NOTICE": {
|
||||
let text = body;
|
||||
@@ -422,6 +449,13 @@ function App() {
|
||||
break;
|
||||
}
|
||||
case "PART": {
|
||||
// The user's own PART, sent from this client or another,
|
||||
// closes the tab and adds no message or unread count.
|
||||
if (msg.from === nickRef.current) {
|
||||
removeChannelTab(msg.to);
|
||||
|
||||
break;
|
||||
}
|
||||
const reason = body ? " (" + body + ")" : "";
|
||||
const text = `${msg.from} has parted ${msg.to}${reason}`;
|
||||
if (msg.to) addMessage(msg.to, { ...base, text, system: true });
|
||||
@@ -429,6 +463,29 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case "KICK": {
|
||||
// The kicked nick is in params; the body is the reason.
|
||||
const kicked = Array.isArray(msg.params) ? msg.params[0] : "";
|
||||
const reason = body ? " (" + body + ")" : "";
|
||||
const text = `${kicked} was kicked from ${msg.to} by ${msg.from}${reason}`;
|
||||
if (msg.to) addMessage(msg.to, { ...base, text, system: true });
|
||||
if (kicked === nickRef.current) {
|
||||
// The channel's tab closes, so the Server tab gets the line
|
||||
// too. It needs an id of its own: addMessage drops a message
|
||||
// whose id it has already seen.
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
id: msg.id + "-server",
|
||||
text,
|
||||
system: true,
|
||||
});
|
||||
removeChannelTab(msg.to);
|
||||
} else if (msg.to && msg.to.startsWith("#")) {
|
||||
refreshMembers(msg.to);
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case "QUIT": {
|
||||
const reason = body ? " (" + body + ")" : "";
|
||||
const text = `${msg.from} has quit${reason}`;
|
||||
@@ -464,8 +521,18 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case "353": {
|
||||
// RPL_NAMREPLY — parse mode prefixes from names list.
|
||||
case "MODE": {
|
||||
// The body is the change, with its value where it has one:
|
||||
// ["+o bob"], ["+m"], ["+k", "secretpass"].
|
||||
const modes = Array.isArray(msg.body) ? msg.body.join(" ") : "";
|
||||
const text = `${msg.from} sets mode ${modes} on ${msg.to}`;
|
||||
if (msg.to) addMessage(msg.to, { ...base, text, system: true });
|
||||
|
||||
break;
|
||||
}
|
||||
case 353: {
|
||||
// RPL_NAMREPLY — each name is a hostmask (nick!user@host),
|
||||
// prefixed with @ for an operator or + for a voiced member.
|
||||
if (
|
||||
Array.isArray(msg.params) &&
|
||||
msg.params.length >= 2 &&
|
||||
@@ -477,21 +544,18 @@ function App() {
|
||||
: String(msg.body);
|
||||
const names = namesStr.split(/\s+/).filter(Boolean);
|
||||
const parsed = names.map((n) => {
|
||||
if (n.startsWith("@")) {
|
||||
return { nick: n.slice(1), mode: "o" };
|
||||
}
|
||||
if (n.startsWith("+")) {
|
||||
return { nick: n.slice(1), mode: "v" };
|
||||
}
|
||||
const isOperator = n.startsWith("@");
|
||||
const isVoiced = n.startsWith("+");
|
||||
const hostmask = isOperator || isVoiced ? n.slice(1) : n;
|
||||
|
||||
return { nick: n, mode: "" };
|
||||
return { nick: hostmask.split("!")[0], isOperator, isVoiced };
|
||||
});
|
||||
setMembers((prev) => ({ ...prev, [channel]: parsed }));
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case "332": {
|
||||
case 332: {
|
||||
// RPL_TOPIC — set topic from server.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
||||
const channel = msg.params[0];
|
||||
@@ -503,13 +567,13 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case "322": {
|
||||
case 322: {
|
||||
// RPL_LIST — channel, member count, topic.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 2) {
|
||||
const chName = msg.params[0];
|
||||
const count = msg.params[1];
|
||||
const chTopic = body || "";
|
||||
addMessage("Server", {
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: `${chName} (${count} users): ${chTopic.trim()}`,
|
||||
system: true,
|
||||
@@ -518,21 +582,21 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case "323":
|
||||
addMessage("Server", {
|
||||
case 323:
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: body || "End of channel list",
|
||||
system: true,
|
||||
});
|
||||
|
||||
break;
|
||||
case "352": {
|
||||
case 352: {
|
||||
// RPL_WHOREPLY — channel, user, host, server, nick, flags.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 5) {
|
||||
const whoCh = msg.params[0];
|
||||
const whoNick = msg.params[4];
|
||||
const whoFlags = msg.params.length > 5 ? msg.params[5] : "";
|
||||
addMessage("Server", {
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: `${whoCh} ${whoNick} ${whoFlags}`,
|
||||
system: true,
|
||||
@@ -541,33 +605,33 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case "315":
|
||||
addMessage("Server", {
|
||||
case 315:
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: body || "End of /WHO list",
|
||||
system: true,
|
||||
});
|
||||
|
||||
break;
|
||||
case "311": {
|
||||
// RPL_WHOISUSER — nick, user, host, *, realname.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
||||
const wiNick = msg.params[0];
|
||||
addMessage("Server", {
|
||||
case 311: {
|
||||
// RPL_WHOISUSER — params nick, user, host, *; body realname.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 3) {
|
||||
const [wiNick, wiUser, wiHost] = msg.params;
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: `${wiNick} (${body})`,
|
||||
text: `${wiNick} is ${wiUser}@${wiHost} (${body})`,
|
||||
system: true,
|
||||
});
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case "312": {
|
||||
case 312: {
|
||||
// RPL_WHOISSERVER — nick, server, server info.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 2) {
|
||||
const wiNick = msg.params[0];
|
||||
const wiServer = msg.params[1];
|
||||
addMessage("Server", {
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: `${wiNick} on ${wiServer}`,
|
||||
system: true,
|
||||
@@ -576,11 +640,37 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case "319": {
|
||||
case 313: {
|
||||
// RPL_WHOISOPERATOR — nick; body "is an IRC operator".
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: `${msg.params[0]} ${body}`,
|
||||
system: true,
|
||||
});
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case 317: {
|
||||
// RPL_WHOISIDLE — nick, idle seconds, signon time (Unix).
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 3) {
|
||||
const [wiNick, idle, signon] = msg.params;
|
||||
const signedOn = new Date(Number(signon) * 1000).toLocaleString();
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: `${wiNick} has been idle ${idle}s, signed on ${signedOn}`,
|
||||
system: true,
|
||||
});
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case 319: {
|
||||
// RPL_WHOISCHANNELS — nick, channels.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
||||
const wiNick = msg.params[0];
|
||||
addMessage("Server", {
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: `${wiNick} is on: ${body}`,
|
||||
system: true,
|
||||
@@ -589,27 +679,39 @@ function App() {
|
||||
|
||||
break;
|
||||
}
|
||||
case "318":
|
||||
addMessage("Server", {
|
||||
case 318:
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: body || "End of /WHOIS list",
|
||||
system: true,
|
||||
});
|
||||
|
||||
break;
|
||||
case "375":
|
||||
case "372":
|
||||
case "376":
|
||||
addMessage("Server", { ...base, text: body, system: true });
|
||||
case 324: {
|
||||
// RPL_CHANNELMODEIS — channel, mode string.
|
||||
if (Array.isArray(msg.params) && msg.params.length >= 2) {
|
||||
addMessage(SERVER_TAB, {
|
||||
...base,
|
||||
text: `${msg.params[0]} modes: ${msg.params[1]}`,
|
||||
system: true,
|
||||
});
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case 375:
|
||||
case 372:
|
||||
case 376:
|
||||
addMessage(SERVER_TAB, { ...base, text: body, system: true });
|
||||
|
||||
break;
|
||||
default:
|
||||
if (body) {
|
||||
addMessage("Server", { ...base, text: body, system: true });
|
||||
addMessage(SERVER_TAB, { ...base, text: body, system: true });
|
||||
}
|
||||
}
|
||||
},
|
||||
[addMessage, refreshMembers],
|
||||
[addMessage, refreshMembers, removeChannelTab],
|
||||
);
|
||||
|
||||
// Long-poll loop.
|
||||
@@ -637,6 +739,14 @@ function App() {
|
||||
} catch (err) {
|
||||
if (!alive) break;
|
||||
if (err.name === "AbortError") continue;
|
||||
// 401: the session is gone (QUIT from another client, or
|
||||
// expiry). Reloading drops this page's state and brings
|
||||
// back the login screen.
|
||||
if (err.status === 401) {
|
||||
window.location.reload();
|
||||
|
||||
return;
|
||||
}
|
||||
setConnected(false);
|
||||
await new Promise((r) => setTimeout(r, RECONNECT_DELAY));
|
||||
}
|
||||
@@ -716,9 +826,14 @@ function App() {
|
||||
|
||||
const onLogin = useCallback(
|
||||
async (userNick, isResumed) => {
|
||||
// Read before setLoggedIn(true): from then on the effect under
|
||||
// "Persist joined channels" writes the open channel tabs over it.
|
||||
const saved = JSON.parse(
|
||||
localStorage.getItem("neoirc_channels") || "[]",
|
||||
);
|
||||
setNick(userNick);
|
||||
setLoggedIn(true);
|
||||
addSystemMessage("Server", `Connected as ${userNick}`);
|
||||
addSystemMessage(SERVER_TAB, `Connected as ${userNick}`);
|
||||
|
||||
if (isResumed) {
|
||||
// Request MOTD on resumed sessions (new sessions
|
||||
@@ -740,15 +855,13 @@ function App() {
|
||||
}
|
||||
|
||||
// Fresh session — join any previously saved channels.
|
||||
const saved = JSON.parse(
|
||||
localStorage.getItem("neoirc_channels") || "[]",
|
||||
);
|
||||
for (const ch of saved) {
|
||||
try {
|
||||
await api("/messages", {
|
||||
const res = await api("/messages", {
|
||||
method: "POST",
|
||||
body: JSON.stringify({ command: "JOIN", to: ch }),
|
||||
});
|
||||
if (res?.status !== "joined") continue;
|
||||
setTabs((prev) => {
|
||||
if (prev.find((t) => t.type === "channel" && t.name === ch))
|
||||
return prev;
|
||||
@@ -768,18 +881,30 @@ function App() {
|
||||
name = name.trim();
|
||||
if (!name.startsWith("#")) name = "#" + name;
|
||||
try {
|
||||
await api("/messages", {
|
||||
const res = await api("/messages", {
|
||||
method: "POST",
|
||||
body: JSON.stringify({ command: "JOIN", to: name }),
|
||||
});
|
||||
// A refused join opens no tab. The error numeric that the
|
||||
// server sends to the message queue tells the user why.
|
||||
if (res?.status !== "joined") return;
|
||||
// Show the channel's tab. Preact runs this update at once on the
|
||||
// newest tab list, so the tab is found there by name: the user's
|
||||
// own JOIN event may already have added it, and other tabs may
|
||||
// have closed.
|
||||
setTabs((prev) => {
|
||||
if (prev.find((t) => t.type === "channel" && t.name === name))
|
||||
const idx = prev.findIndex(
|
||||
(t) => t.type === "channel" && t.name === name,
|
||||
);
|
||||
if (idx >= 0) {
|
||||
setActiveTab(idx);
|
||||
|
||||
return prev;
|
||||
}
|
||||
setActiveTab(prev.length);
|
||||
|
||||
return [...prev, { type: "channel", name }];
|
||||
});
|
||||
const newIdx = tabsRef.current.length;
|
||||
setActiveTab(newIdx);
|
||||
try {
|
||||
const hist = await api(
|
||||
`/history?target=${encodeURIComponent(name)}&limit=50`,
|
||||
@@ -792,7 +917,7 @@ function App() {
|
||||
}
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
`Failed to join ${name}: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
@@ -808,10 +933,7 @@ function App() {
|
||||
} catch (e) {
|
||||
// Ignore.
|
||||
}
|
||||
setTabs((prev) =>
|
||||
prev.filter((t) => !(t.type === "channel" && t.name === name)),
|
||||
);
|
||||
setActiveTab(0);
|
||||
removeChannelTab(name);
|
||||
};
|
||||
|
||||
const closeTab = (idx) => {
|
||||
@@ -826,16 +948,23 @@ function App() {
|
||||
|
||||
const openDM = (targetNick) => {
|
||||
if (targetNick === nickRef.current) return;
|
||||
// Show the direct-message tab. Preact runs this update at once on
|
||||
// the newest tab list, so the tab is found there by name: the
|
||||
// server's copy of the user's message may already have added it,
|
||||
// and other tabs may have opened or closed.
|
||||
setTabs((prev) => {
|
||||
if (prev.find((t) => t.type === "dm" && t.name === targetNick))
|
||||
const idx = prev.findIndex(
|
||||
(t) => t.type === "dm" && t.name === targetNick,
|
||||
);
|
||||
if (idx >= 0) {
|
||||
setActiveTab(idx);
|
||||
|
||||
return prev;
|
||||
}
|
||||
setActiveTab(prev.length);
|
||||
|
||||
return [...prev, { type: "dm", name: targetNick }];
|
||||
});
|
||||
const idx = tabs.findIndex(
|
||||
(t) => t.type === "dm" && t.name === targetNick,
|
||||
);
|
||||
setActiveTab(idx >= 0 ? idx : tabs.length);
|
||||
};
|
||||
|
||||
const handleCommand = async (text) => {
|
||||
@@ -846,7 +975,7 @@ function App() {
|
||||
switch (cmd) {
|
||||
case "/join": {
|
||||
if (parts[1]) joinChannel(parts[1]);
|
||||
else addSystemMessage("Server", "Usage: /join #channel");
|
||||
else addSystemMessage(SERVER_TAB, "Usage: /join #channel");
|
||||
|
||||
break;
|
||||
}
|
||||
@@ -855,7 +984,7 @@ function App() {
|
||||
const reason = parts.slice(1).join(" ") || undefined;
|
||||
partChannel(tab.name, reason);
|
||||
} else {
|
||||
addSystemMessage("Server", "You are not in a channel");
|
||||
addSystemMessage(SERVER_TAB, "You are not in a channel");
|
||||
}
|
||||
|
||||
break;
|
||||
@@ -876,19 +1005,19 @@ function App() {
|
||||
openDM(target);
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
`Message failed: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
} else {
|
||||
addSystemMessage("Server", "Usage: /msg <nick> <message>");
|
||||
addSystemMessage(SERVER_TAB, "Usage: /msg <nick> <message>");
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case "/me": {
|
||||
if (tab.type === "server") {
|
||||
addSystemMessage("Server", "Cannot use /me in server window");
|
||||
addSystemMessage(SERVER_TAB, "Cannot use /me in server window");
|
||||
|
||||
break;
|
||||
}
|
||||
@@ -910,7 +1039,7 @@ function App() {
|
||||
);
|
||||
}
|
||||
} else {
|
||||
addSystemMessage("Server", "Usage: /me <action>");
|
||||
addSystemMessage(SERVER_TAB, "Usage: /me <action>");
|
||||
}
|
||||
|
||||
break;
|
||||
@@ -924,19 +1053,19 @@ function App() {
|
||||
});
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
`Nick change failed: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
} else {
|
||||
addSystemMessage("Server", "Usage: /nick <newnick>");
|
||||
addSystemMessage(SERVER_TAB, "Usage: /nick <newnick>");
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case "/topic": {
|
||||
if (tab.type !== "channel") {
|
||||
addSystemMessage("Server", "You are not in a channel");
|
||||
addSystemMessage(SERVER_TAB, "You are not in a channel");
|
||||
|
||||
break;
|
||||
}
|
||||
@@ -953,13 +1082,13 @@ function App() {
|
||||
});
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
`Topic change failed: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
} else {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
`Current topic for ${tab.name}: ${topics[tab.name] || "(none)"}`,
|
||||
);
|
||||
}
|
||||
@@ -968,31 +1097,26 @@ function App() {
|
||||
}
|
||||
case "/mode": {
|
||||
if (tab.type !== "channel") {
|
||||
addSystemMessage("Server", "You are not in a channel");
|
||||
addSystemMessage(SERVER_TAB, "You are not in a channel");
|
||||
|
||||
break;
|
||||
}
|
||||
// With no arguments MODE is a query. A change is one sign and
|
||||
// letter, then its value where it takes one: +m, +o nick.
|
||||
const modeArgs = parts.slice(1);
|
||||
if (modeArgs.length > 0) {
|
||||
const body =
|
||||
modeArgs.length > 0
|
||||
? { command: "MODE", to: tab.name, body: modeArgs }
|
||||
: { command: "MODE", to: tab.name };
|
||||
try {
|
||||
await api("/messages", {
|
||||
method: "POST",
|
||||
body: JSON.stringify({
|
||||
command: "MODE",
|
||||
to: tab.name,
|
||||
params: modeArgs,
|
||||
}),
|
||||
body: JSON.stringify(body),
|
||||
});
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
`Mode change failed: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
} else {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
"Usage: /mode <+/-mode> [params]",
|
||||
SERVER_TAB,
|
||||
`MODE failed: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1009,7 +1133,6 @@ function App() {
|
||||
} catch (e) {
|
||||
// Ignore.
|
||||
}
|
||||
localStorage.removeItem("neoirc_token");
|
||||
localStorage.removeItem("neoirc_channels");
|
||||
window.location.reload();
|
||||
|
||||
@@ -1023,7 +1146,7 @@ function App() {
|
||||
});
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
`Failed to request MOTD: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
@@ -1047,13 +1170,13 @@ function App() {
|
||||
});
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
`Message failed: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
addSystemMessage("Server", "Usage: /query <nick> [message]");
|
||||
addSystemMessage(SERVER_TAB, "Usage: /query <nick> [message]");
|
||||
}
|
||||
|
||||
break;
|
||||
@@ -1066,7 +1189,7 @@ function App() {
|
||||
});
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
`Failed to list channels: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
@@ -1083,12 +1206,12 @@ function App() {
|
||||
});
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
`WHO failed: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
} else {
|
||||
addSystemMessage("Server", "Usage: /who #channel");
|
||||
addSystemMessage(SERVER_TAB, "Usage: /who #channel");
|
||||
}
|
||||
|
||||
break;
|
||||
@@ -1102,12 +1225,12 @@ function App() {
|
||||
});
|
||||
} catch (err) {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
`WHOIS failed: ${err.data?.error || "error"}`,
|
||||
);
|
||||
}
|
||||
} else {
|
||||
addSystemMessage("Server", "Usage: /whois <nick>");
|
||||
addSystemMessage(SERVER_TAB, "Usage: /whois <nick>");
|
||||
}
|
||||
|
||||
break;
|
||||
@@ -1128,7 +1251,7 @@ function App() {
|
||||
" /me action — Send an action",
|
||||
" /nick newnick — Change your nickname",
|
||||
" /topic [text] — View or set channel topic",
|
||||
" /mode +/-flags — Set channel modes",
|
||||
" /mode [+/-flag [arg]] — View or set channel modes",
|
||||
" /motd — Display the message of the day",
|
||||
" /list — List all channels",
|
||||
" /who [#channel] — List users in a channel",
|
||||
@@ -1138,13 +1261,13 @@ function App() {
|
||||
" /help — Show this help",
|
||||
];
|
||||
for (const line of helpLines) {
|
||||
addSystemMessage("Server", line);
|
||||
addSystemMessage(SERVER_TAB, line);
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
default:
|
||||
addSystemMessage("Server", `Unknown command: ${cmd}`);
|
||||
addSystemMessage(SERVER_TAB, `Unknown command: ${cmd}`);
|
||||
}
|
||||
};
|
||||
|
||||
@@ -1173,7 +1296,7 @@ function App() {
|
||||
|
||||
if (tab.type === "server") {
|
||||
addSystemMessage(
|
||||
"Server",
|
||||
SERVER_TAB,
|
||||
"Cannot send messages to the server window. Use /join #channel first.",
|
||||
);
|
||||
|
||||
@@ -1244,7 +1367,7 @@ function App() {
|
||||
key={tab.name}
|
||||
>
|
||||
<span class="tab-label">
|
||||
{tab.type === "dm" ? tab.name : tab.name}
|
||||
{tab.type === "server" ? "Server" : tab.name}
|
||||
</span>
|
||||
{unread[tab.name] > 0 && i !== activeTab && (
|
||||
<span class="unread-count">({unread[tab.name]})</span>
|
||||
|
||||
Reference in New Issue
Block a user