Compare commits
15
Commits
faf2c861c1
..
next
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bc8aa6bb96 | ||
|
|
bc7ef8240b | ||
|
|
8afd873813 | ||
|
|
c12668226f | ||
|
|
4221f71920 | ||
|
|
254873a656 | ||
|
|
0b63384423 | ||
|
|
c4fc156a8c | ||
|
|
5fe325399b | ||
|
|
24e8b4d027 | ||
|
|
562ce87245 | ||
|
|
1e2f0de877 | ||
|
|
2b1a49e59b | ||
|
|
7968be00e7 | ||
|
|
acb9527944 |
@@ -1,55 +1,73 @@
|
||||
# AGENTS.md — Rules for AI Agents
|
||||
# Rules for coding agents
|
||||
|
||||
## Before Every Commit
|
||||
This file holds the rules for coding agents working in this repository.
|
||||
`CONVENTIONS.md` defines the architecture. `REPO_POLICIES.md` defines the
|
||||
repository standards. Both are copies of shared documents. Do not edit them
|
||||
here.
|
||||
|
||||
1. **Format**: `make fmt`
|
||||
2. **Check**: `make check` — the tests and the linter, which run in Docker, and
|
||||
the format check: all passing, zero issues
|
||||
## Before every commit
|
||||
|
||||
Never run `go test`, `golangci-lint` or `gofmt` directly; use the `make`
|
||||
targets.
|
||||
1. Run `make fmt`.
|
||||
2. Run `make check`. It runs the tests and the linter in Docker, then the format
|
||||
check. All three must pass with no findings.
|
||||
|
||||
No commit lands on main with lint errors, test failures, or formatting issues.
|
||||
Never run `go test`, `golangci-lint` or `gofmt` directly. Use the `make` targets
|
||||
instead, such as `make test` and `make lint`.
|
||||
|
||||
## Code Style
|
||||
## Branches and pull requests
|
||||
|
||||
- Follow CONVENTIONS.md exactly — it defines the architecture
|
||||
- All exported types, functions, methods, and vars must have doc comments
|
||||
- All packages must have a package doc comment
|
||||
- JSON tags use camelCase (not snake_case)
|
||||
- No magic numbers — use named constants
|
||||
- No inline error handling (`if err := ...; err != nil`) — use plain assignment
|
||||
- Blank line before every `return` statement
|
||||
- Blank line separating embedded fields from regular fields in structs
|
||||
- Blank imports must have a justification comment
|
||||
- Never commit to `main` or `next` directly. Every change is a pull request from
|
||||
a feature branch into `next`.
|
||||
- Only the owner merges `next` into `main`.
|
||||
- A pull request that closes an issue has the title `Description (closes #N)`.
|
||||
- One logical change per commit.
|
||||
- Commit messages are in the imperative mood and short.
|
||||
|
||||
## Git Workflow
|
||||
## Code style
|
||||
|
||||
- **Never commit directly to main** — all changes go on feature branches
|
||||
- Merge to main only when ready and passing all checks
|
||||
- PR titles: `Description (closes #N)` when closing an issue
|
||||
- One logical change per commit
|
||||
- Commit messages: imperative mood, concise
|
||||
- Follow `CONVENTIONS.md`.
|
||||
- Every package has a package doc comment. Test files need none.
|
||||
- Every exported type, function and variable has a doc comment. Test files need
|
||||
none.
|
||||
- JSON tags are camelCase. The HTTP API's `last_id`, `pow_token` and
|
||||
`hashcash_bits` stay as they are, each with a `//nolint:tagliatelle` comment.
|
||||
- Prefer named constants to magic numbers. The `mnd` linter checks for them
|
||||
outside test files.
|
||||
- No inline error handling such as `if err := f(); err != nil`. Assign the error
|
||||
on its own line, then test it.
|
||||
- A `return` that follows another statement in its block has a blank line before
|
||||
it.
|
||||
- A blank line between the embedded fields of a struct and its other fields.
|
||||
- Every blank import has a comment saying why it is there. Test files need none.
|
||||
|
||||
## Architecture
|
||||
|
||||
- Dependency injection via Uber fx — all components are fx providers
|
||||
- `internal/` for all application packages — one package per concern
|
||||
- Handlers return `http.HandlerFunc` using the closure pattern
|
||||
- Request/response structs defined inside handler closures
|
||||
- Models embed `models.Base` for database access to relation methods
|
||||
- Database migrations in `internal/db/schema/` — embedded via `go:embed`
|
||||
- SQLite by default (pure Go driver: modernc.org/sqlite)
|
||||
- The server uses `go.uber.org/fx` for dependency injection.
|
||||
`cmd/neoircd/main.go` lists its `fx` providers, such as `db.New` and
|
||||
`handlers.New`.
|
||||
- Application packages live under `internal/`, one package per concern.
|
||||
- `pkg/irc` holds the IRC command names and numeric reply codes.
|
||||
- The `web` package embeds the built web client.
|
||||
- Each exported `Handle…` method of `Handlers` returns an `http.HandlerFunc`.
|
||||
- A request struct is defined inside the method that decodes it.
|
||||
- The server uses the database only through the methods of `db.Database`.
|
||||
- The database migrations live in `internal/db/schema/` and are embedded with
|
||||
`go:embed`.
|
||||
- The database is SQLite, through the pure Go driver `modernc.org/sqlite`.
|
||||
|
||||
## Testing
|
||||
|
||||
- Table-driven tests preferred
|
||||
- Use `testing.T` helpers, not assertion libraries
|
||||
- Test files live next to the code they test
|
||||
- `_test.go` suffix, same package for white-box testing
|
||||
- Prefer table-driven tests.
|
||||
- Use `testing.T` helpers, not assertion libraries.
|
||||
- A test file lives next to the code it tests and ends in `_test.go`.
|
||||
- The linter requires each test file to be in the package's external test
|
||||
package, such as `handlers_test`. It allows `export_test.go` and files ending
|
||||
in `_internal_test.go` in the package itself.
|
||||
- An `export_test.go` file gives the external tests access to the package's
|
||||
unexported code.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Required libraries are listed in CONVENTIONS.md §1
|
||||
- No new dependencies without justification
|
||||
- Pure Go preferred (no CGO)
|
||||
- The required libraries are listed in `CONVENTIONS.md` §1.
|
||||
- No new dependency without a reason given in the pull request.
|
||||
- Prefer dependencies written in pure Go, which build without cgo.
|
||||
|
||||
+8
-4
@@ -33,14 +33,18 @@ RUN golangci-lint run --config .golangci.yml ./...
|
||||
# golang:1.24.13-bookworm, 2026-10-06
|
||||
FROM golang@sha256:1a6d4452c65dea36aac2e2d606b01b4a029ec90cc1ae53890540ce6173ea77ac AS test
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
COPY . .
|
||||
RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css web/dist/app.js
|
||||
# -p 4 because test runs on a shared build host cap their parallelism.
|
||||
RUN go test -p 4 -timeout 90s -race -cover ./... || \
|
||||
# The modules download in this RUN rather than a layer of their own, because
|
||||
# exporting a layer that holds them is slow. Nothing reads them or the build
|
||||
# cache afterwards, so go clean removes both.
|
||||
RUN set -e; \
|
||||
go mod download; \
|
||||
go test -p 4 -timeout 90s -race -cover ./... || \
|
||||
{ echo "--- Rerunning with -v for details ---"; \
|
||||
go test -p 4 -timeout 90s -race -v ./...; exit 1; }
|
||||
go test -p 4 -timeout 90s -race -v ./...; exit 1; }; \
|
||||
go clean -cache -modcache
|
||||
|
||||
# Build stage. Nothing is wanted from either phase above; the copies
|
||||
# are what make BuildKit build them first, so this stage cannot run
|
||||
|
||||
+61
-53
@@ -108,7 +108,7 @@ func (a *App) handleInput(text string) {
|
||||
})
|
||||
if err != nil {
|
||||
a.ui.AddStatus(
|
||||
"[red]Send error: " + err.Error(),
|
||||
"[red]Send error: " + escape(err.Error()),
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -166,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),
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -182,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
|
||||
@@ -192,9 +192,9 @@ 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
|
||||
}
|
||||
@@ -218,7 +218,7 @@ func (a *App) cmdConnect(serverURL string) {
|
||||
|
||||
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")
|
||||
|
||||
@@ -244,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)",
|
||||
)
|
||||
|
||||
@@ -256,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
|
||||
}
|
||||
@@ -269,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) {
|
||||
@@ -297,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
|
||||
}
|
||||
@@ -337,9 +337,9 @@ 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
|
||||
}
|
||||
@@ -384,9 +384,9 @@ func (a *App) cmdMsg(args string) {
|
||||
Body: []string{text},
|
||||
})
|
||||
if err != nil {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
"[red]Send failed: %v", err,
|
||||
))
|
||||
a.ui.AddStatus(
|
||||
"[red]Send failed: " + escape(err.Error()),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -402,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) {
|
||||
@@ -439,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()),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -465,9 +471,9 @@ 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
|
||||
}
|
||||
@@ -480,7 +486,7 @@ func (a *App) cmdNames() {
|
||||
|
||||
a.ui.AddLine(target, fmt.Sprintf(
|
||||
"[cyan]*** Members of %s: %s",
|
||||
target, strings.Join(nicks, " "),
|
||||
escape(target), escape(strings.Join(nicks, " ")),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -511,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
|
||||
}
|
||||
@@ -522,7 +528,7 @@ func (a *App) cmdList() {
|
||||
|
||||
for _, ch := range channels {
|
||||
a.ui.AddStatus(fmt.Sprintf(
|
||||
" %s %s", ch.Name, ch.Topic,
|
||||
" %s %s", escape(ch.Name), escape(ch.Topic),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -544,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()),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -582,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()),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -613,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()),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -818,7 +824,7 @@ func (a *App) handlePrivmsgEvent(
|
||||
|
||||
a.ui.AddLine(target, fmt.Sprintf(
|
||||
"[gray]%s [green]<%s>[white] %s",
|
||||
timestamp, msg.From, text,
|
||||
timestamp, escape(msg.From), escape(text),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -831,7 +837,7 @@ 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),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -850,11 +856,11 @@ func (a *App) handlePartEvent(
|
||||
|
||||
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 += " (" + reason + ")"
|
||||
line += " (" + escape(reason) + ")"
|
||||
}
|
||||
|
||||
if msg.From == myNick {
|
||||
@@ -875,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),
|
||||
))
|
||||
}
|
||||
}
|
||||
@@ -907,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),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -919,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),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -935,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),
|
||||
))
|
||||
}
|
||||
|
||||
@@ -945,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),
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,6 +8,7 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
"unicode/utf8"
|
||||
|
||||
"github.com/gdamore/tcell/v2"
|
||||
api "sneak.berlin/go/neoirc/internal/cli/api"
|
||||
@@ -23,6 +24,13 @@ const (
|
||||
testText = "hello"
|
||||
)
|
||||
|
||||
// What the status bar shows while the client is connected, and
|
||||
// while it is not.
|
||||
const (
|
||||
statusConnected = "[connected]"
|
||||
statusDisconnected = "[disconnected]"
|
||||
)
|
||||
|
||||
// eventLoopTimeout is how long a test waits for a typed line to
|
||||
// be handled, for the welcome lines, for the UI to stop, for a poll
|
||||
// or for a poll loop to end, before it fails.
|
||||
@@ -361,6 +369,46 @@ func TestWindowConnectionState(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestQueryConnectionState checks that typing /query bob leaves the
|
||||
// status bar showing [connected] only while the client is connected,
|
||||
// and [disconnected] otherwise.
|
||||
func TestQueryConnectionState(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const line = "/query " + testOtherNick
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
connected bool
|
||||
want string
|
||||
}{
|
||||
{name: "not connected", connected: false, want: statusDisconnected},
|
||||
{name: "connected", connected: true, want: statusConnected},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
app := &App{ui: NewUI(), nick: testNick, connected: test.connected}
|
||||
handled := handledLines(app)
|
||||
runUI(t, app.ui)
|
||||
|
||||
for _, r := range line {
|
||||
app.ui.app.QueueEvent(tcell.NewEventKey(tcell.KeyRune, r, tcell.ModNone))
|
||||
}
|
||||
|
||||
app.ui.app.QueueEvent(tcell.NewEventKey(tcell.KeyEnter, 0, tcell.ModNone))
|
||||
waitHandled(t, handled, line)
|
||||
|
||||
status := statusBarText(app.ui)
|
||||
if !strings.Contains(status, test.want) {
|
||||
t.Fatalf("status bar is %q, want it to show %s", status, test.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestEventLoopKeepsRunning sends Alt and 1, then a typed line and
|
||||
// Enter, to a running UI. It checks that both are handled, so the
|
||||
// event loop did not stop on either.
|
||||
@@ -752,6 +800,31 @@ func TestStatusBar(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestUnreadLine checks that a line added to a window that is not
|
||||
// shown puts that window in the status bar's unread list at once,
|
||||
// and that the status bar keeps the nick, target and connection
|
||||
// state last set.
|
||||
func TestUnreadLine(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ui := NewUI()
|
||||
runUI(t, ui)
|
||||
|
||||
// Window 1, the one shown, is the channel's. The line goes to
|
||||
// window 2 after SetStatus, so only AddLine can show it in the
|
||||
// status bar.
|
||||
ui.SwitchToBuffer(testChannel)
|
||||
ui.SetStatus(testNick, testChannel, "connected")
|
||||
ui.AddLine(testOtherNick, testText)
|
||||
|
||||
const want = " [connected] erin [1:#chan] #chan [Act: 2:bob(1)]"
|
||||
|
||||
got := statusBarText(ui)
|
||||
if got != want {
|
||||
t.Fatalf("status bar is %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// TestOwnEventFromOtherClient checks that a message, notice,
|
||||
// join or part that the user's session makes from another
|
||||
// client shows as one line in the buffer it belongs to.
|
||||
@@ -820,6 +893,260 @@ func TestOwnEventFromOtherClient(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestBracketsInMessageWindow checks that each kind of line drawn
|
||||
// from a server event shows nicks, channel names, texts, reasons
|
||||
// and topics holding square brackets as written.
|
||||
func TestBracketsInMessageWindow(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// Every event is sent to this channel and has a body of one line.
|
||||
const channel = "#chan[x]"
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
command string
|
||||
from string
|
||||
body string
|
||||
// Whether the line goes to the channel's window rather than
|
||||
// the status window, which is the one shown at start.
|
||||
inChannel bool
|
||||
// How the line ends, after the timestamps.
|
||||
want string
|
||||
}{
|
||||
{
|
||||
name: "message", command: irc.CmdPrivmsg, inChannel: true,
|
||||
from: "bob[|[]", body: "x[^[] [:::y|z] [red]",
|
||||
want: "<bob[|[]> x[^[] [:::y|z] [red]",
|
||||
},
|
||||
{
|
||||
name: "joined", command: irc.CmdJoin, from: "x[^[]", inChannel: true,
|
||||
want: "*** x[^[] has joined #chan[x]",
|
||||
},
|
||||
{
|
||||
name: "left", command: irc.CmdPart, inChannel: true,
|
||||
from: "erin[away]", body: "[:::y|z]",
|
||||
want: "*** erin[away] has left #chan[x] ([:::y|z])",
|
||||
},
|
||||
{
|
||||
name: "topic", command: irc.CmdTopic, inChannel: true,
|
||||
from: "dave[afk]", body: "[red]news",
|
||||
want: "*** dave[afk] set topic: [red]news",
|
||||
},
|
||||
{
|
||||
name: "quit", command: irc.CmdQuit, from: "carol[x]", body: "bye [red]",
|
||||
want: "*** carol[x] has quit (bye [red])",
|
||||
},
|
||||
{
|
||||
name: "quit without reason", command: irc.CmdQuit, from: "frank[x]",
|
||||
want: "*** frank[x] has quit",
|
||||
},
|
||||
{
|
||||
name: "nick change", command: irc.CmdNick, from: "erin[m]", body: "erin[x]",
|
||||
want: "*** erin[m] is now known as erin[x]",
|
||||
},
|
||||
{
|
||||
name: "notice", command: irc.CmdNotice, from: "bob[x]", body: "[::b]note",
|
||||
want: "--bob[x]-- [::b]note",
|
||||
},
|
||||
{
|
||||
name: "other command", command: irc.CmdMode, body: "+v dave[afk]",
|
||||
want: "[MODE] +v dave[afk]",
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
app := &App{ui: NewUI(), nick: testNick}
|
||||
screen := runUI(t, app.ui)
|
||||
|
||||
if test.inChannel {
|
||||
app.ui.SwitchToBuffer(channel)
|
||||
}
|
||||
|
||||
app.handleServerMessage(&api.Message{
|
||||
Command: test.command, From: test.from, To: channel,
|
||||
Body: []string{test.body},
|
||||
})
|
||||
|
||||
got, _ := shownLine(app.ui, screen, 0)
|
||||
if !strings.HasSuffix(got, test.want) {
|
||||
t.Fatalf("message window shows %q, want it to end %q", got, test.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestBracketsInCommandErrors checks that when the server refuses
|
||||
// a typed command, the error the client shows holds the server's
|
||||
// answer as written.
|
||||
func TestBracketsInCommandErrors(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
server := newRefusingServer(t)
|
||||
|
||||
tests := []struct {
|
||||
typed string
|
||||
// The start of the line, before the error.
|
||||
reply string
|
||||
}{
|
||||
{typed: testText, reply: "Send error"},
|
||||
{typed: "/nick bob", reply: "Nick change failed"},
|
||||
{typed: "/join #x", reply: "Join failed"},
|
||||
{typed: "/part", reply: "Part failed"},
|
||||
{typed: "/msg bob hi", reply: "Send failed"},
|
||||
{typed: "/topic hi", reply: "Topic set failed"},
|
||||
{typed: "/names", reply: "Names failed"},
|
||||
{typed: "/list", reply: "List failed"},
|
||||
{typed: "/motd", reply: "MOTD failed"},
|
||||
{typed: "/who", reply: "WHO failed"},
|
||||
{typed: "/whois bob", reply: "WHOIS failed"},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.reply, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
app := &App{
|
||||
ui: NewUI(),
|
||||
client: api.NewClient(server.URL),
|
||||
nick: testNick,
|
||||
target: testChannel,
|
||||
connected: true,
|
||||
}
|
||||
screen := runUI(t, app.ui)
|
||||
|
||||
app.handleInput(test.typed)
|
||||
|
||||
want := test.reply + ": HTTP error 400: [red]no"
|
||||
|
||||
got, _ := shownLine(app.ui, screen, 0)
|
||||
if !strings.HasSuffix(got, want) {
|
||||
t.Fatalf("message window shows %q, want it to end %q", got, want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestBracketsInCommandReplies checks that the other lines the
|
||||
// client draws for a typed command show square brackets as
|
||||
// written, whether they come from the typed line or the server.
|
||||
func TestBracketsInCommandReplies(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const channel = "#chan[x]"
|
||||
|
||||
refusing := newRefusingServer(t)
|
||||
session := newServer(t, `{"id": 1, "nick": "erin[x]"}`)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
// The server the client is connected to before the line is
|
||||
// typed, if any.
|
||||
server *httptest.Server
|
||||
typed string
|
||||
// Whether the line goes to the channel's window rather than
|
||||
// the status window, and which line of the window it is,
|
||||
// counting from 0.
|
||||
inChannel bool
|
||||
line int
|
||||
want string
|
||||
}{
|
||||
{name: "unknown command", typed: "/x[red]", want: "Unknown command: /x[red]"},
|
||||
{
|
||||
name: "nick set", typed: "/nick erin[x]",
|
||||
want: "Nick set to erin[x] (will be used on connect)",
|
||||
},
|
||||
{
|
||||
name: "nick changed", server: session, typed: "/nick erin[x]",
|
||||
want: "Nick changed to erin[x]",
|
||||
},
|
||||
{
|
||||
name: "connecting", typed: "/connect " + refusing.URL + "/[x]",
|
||||
want: "Connecting to " + refusing.URL + "/[x]...",
|
||||
},
|
||||
{
|
||||
name: "connection failed", typed: "/connect " + refusing.URL, line: 1,
|
||||
want: "Connection failed: HTTP error 400: [red]no",
|
||||
},
|
||||
{
|
||||
name: "connected", typed: "/connect " + session.URL, line: 1,
|
||||
want: "Connected! Nick: erin[x], Session: 1",
|
||||
},
|
||||
{
|
||||
name: "members", server: newServer(t, `[{"nick": "bob[x]"}]`),
|
||||
typed: "/names", inChannel: true, want: "*** Members of #chan[x]: bob[x]",
|
||||
},
|
||||
{
|
||||
name: "channel list", typed: "/list", line: 1, want: " #chan[x] [red]news",
|
||||
server: newServer(t, `[{"name": "#chan[x]", "topic": "[red]news"}]`),
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
app := &App{ui: NewUI(), nick: testNick, target: channel}
|
||||
|
||||
if test.server != nil {
|
||||
app.client = api.NewClient(test.server.URL)
|
||||
app.connected = true
|
||||
}
|
||||
|
||||
screen := runUI(t, app.ui)
|
||||
|
||||
// Stop the poll loop a /connect starts, as /quit does.
|
||||
// Cleanups run last first, so this runs before the UI
|
||||
// stops.
|
||||
t.Cleanup(func() {
|
||||
app.mu.Lock()
|
||||
defer app.mu.Unlock()
|
||||
|
||||
if app.stopPoll != nil {
|
||||
close(app.stopPoll)
|
||||
}
|
||||
})
|
||||
|
||||
if test.inChannel {
|
||||
app.ui.SwitchToBuffer(channel)
|
||||
}
|
||||
|
||||
app.handleInput(test.typed)
|
||||
|
||||
got, _ := shownLine(app.ui, screen, test.line)
|
||||
if !strings.HasSuffix(got, test.want) {
|
||||
t.Fatalf("message window shows %q, want it to end %q", got, test.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestColourTagInMessage checks that a colour tag in a message
|
||||
// shows as written and leaves the message text white, as the
|
||||
// client draws it.
|
||||
func TestColourTagInMessage(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const want = "<bob> [red]x"
|
||||
|
||||
app := &App{ui: NewUI(), nick: testNick}
|
||||
screen := runUI(t, app.ui)
|
||||
app.ui.SwitchToBuffer(testChannel)
|
||||
|
||||
app.handleServerMessage(&api.Message{
|
||||
Command: irc.CmdPrivmsg, From: testOtherNick, To: testChannel,
|
||||
Body: []string{"[red]x"},
|
||||
})
|
||||
|
||||
got, colour := shownLine(app.ui, screen, 0)
|
||||
if !strings.HasSuffix(got, want) || colour != tcell.ColorWhite {
|
||||
t.Fatalf("message window shows %q, its last character in %v; "+
|
||||
"want it to end %q, in white", got, colour, want)
|
||||
}
|
||||
}
|
||||
|
||||
// bufferState returns the number of lines in the named
|
||||
// buffer and how many of them are unread.
|
||||
func bufferState(ui *UI, name string) (int, int) {
|
||||
@@ -847,6 +1174,41 @@ func statusBarText(ui *UI) string {
|
||||
return text
|
||||
}
|
||||
|
||||
// shownLine returns the given line of the message window, counting
|
||||
// from 0, as the screen shows it, without the blanks after it, and
|
||||
// the colour of its last character. Each line in these tests takes
|
||||
// one row of the screen.
|
||||
func shownLine(
|
||||
ui *UI, screen tcell.SimulationScreen, line int,
|
||||
) (string, tcell.Color) {
|
||||
var (
|
||||
text string
|
||||
colour tcell.Color
|
||||
)
|
||||
|
||||
ui.app.QueueUpdate(func() {
|
||||
cells, width, _ := screen.GetContents()
|
||||
cells = cells[line*width : (line+1)*width]
|
||||
|
||||
var row strings.Builder
|
||||
|
||||
for _, cell := range cells {
|
||||
row.WriteString(string(cell.Runes))
|
||||
}
|
||||
|
||||
text = strings.TrimRight(row.String(), " ")
|
||||
if text == "" {
|
||||
return
|
||||
}
|
||||
|
||||
// Each character in these tests takes one cell.
|
||||
last := cells[utf8.RuneCountInString(text)-1]
|
||||
colour, _, _ = last.Style.Decompose()
|
||||
})
|
||||
|
||||
return text, colour
|
||||
}
|
||||
|
||||
// handledLines makes app.ui pass each typed line to
|
||||
// app.handleInput, as Run does, and returns a channel that
|
||||
// receives each line once it has been handled.
|
||||
@@ -892,6 +1254,23 @@ func newServer(t *testing.T, body string) *httptest.Server {
|
||||
return server
|
||||
}
|
||||
|
||||
// newRefusingServer starts a server that answers every request
|
||||
// with the status 400 Bad Request and the body "[red]no" until
|
||||
// the test ends. The client shows that body in its error.
|
||||
func newRefusingServer(t *testing.T) *httptest.Server {
|
||||
t.Helper()
|
||||
|
||||
server := httptest.NewServer(http.HandlerFunc(
|
||||
func(writer http.ResponseWriter, _ *http.Request) {
|
||||
writer.WriteHeader(http.StatusBadRequest)
|
||||
_, _ = io.WriteString(writer, "[red]no")
|
||||
},
|
||||
))
|
||||
t.Cleanup(server.Close)
|
||||
|
||||
return server
|
||||
}
|
||||
|
||||
// newHoldingServer starts a server that sends on the returned
|
||||
// channel for each poll and holds the poll until its connection
|
||||
// closes. It answers any other request with body.
|
||||
@@ -939,11 +1318,15 @@ func waitPoll(t *testing.T, polled <-chan struct{}, server string) {
|
||||
}
|
||||
}
|
||||
|
||||
// runUI runs ui on a simulated screen until the test ends.
|
||||
func runUI(t *testing.T, ui *UI) {
|
||||
// runUI runs ui on a simulated screen until the test ends, and
|
||||
// returns the screen.
|
||||
//
|
||||
//nolint:ireturn // tcell has no exported type for the screen
|
||||
func runUI(t *testing.T, ui *UI) tcell.SimulationScreen {
|
||||
t.Helper()
|
||||
|
||||
ui.app.SetScreen(tcell.NewSimulationScreen(""))
|
||||
screen := tcell.NewSimulationScreen("")
|
||||
ui.app.SetScreen(screen)
|
||||
|
||||
// One slot, so that Run's goroutine can end even after the
|
||||
// cleanup below has stopped waiting for it.
|
||||
@@ -963,4 +1346,6 @@ func runUI(t *testing.T, ui *UI) {
|
||||
t.Error("the UI did not stop: its event loop stopped responding")
|
||||
}
|
||||
})
|
||||
|
||||
return screen
|
||||
}
|
||||
|
||||
+24
-2
@@ -30,6 +30,12 @@ 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
|
||||
@@ -179,7 +185,11 @@ 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()
|
||||
})
|
||||
}
|
||||
|
||||
@@ -225,6 +235,16 @@ 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() {
|
||||
// Colour tags stay off. With them on, tview reads text in
|
||||
// square brackets, such as "[connected]" or part of a nick,
|
||||
@@ -300,8 +320,10 @@ func (ui *UI) callOnInput(text string) {
|
||||
}()
|
||||
}
|
||||
|
||||
// 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(
|
||||
|
||||
+1
-8
@@ -10,13 +10,6 @@ import (
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
)
|
||||
|
||||
//nolint:gochecknoglobals // var so tests can override via SetBcryptCost
|
||||
var bcryptCost = bcrypt.DefaultCost
|
||||
|
||||
// SetBcryptCost overrides the bcrypt cost.
|
||||
// Use bcrypt.MinCost in tests to avoid slow hashing.
|
||||
func SetBcryptCost(cost int) { bcryptCost = cost }
|
||||
|
||||
var errNoPassword = errors.New(
|
||||
"account has no password set",
|
||||
)
|
||||
@@ -29,7 +22,7 @@ func (database *Database) SetPassword(
|
||||
password string,
|
||||
) error {
|
||||
hash, err := bcrypt.GenerateFromPassword(
|
||||
[]byte(password), bcryptCost,
|
||||
[]byte(password), bcrypt.DefaultCost,
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("hash password: %w", err)
|
||||
|
||||
@@ -85,11 +85,6 @@ func New(
|
||||
return database, nil
|
||||
}
|
||||
|
||||
// GetDB returns the underlying sql.DB connection.
|
||||
func (database *Database) GetDB() *sql.DB {
|
||||
return database.conn
|
||||
}
|
||||
|
||||
func (database *Database) connect(ctx context.Context) error {
|
||||
dbURL := database.params.Config.DBURL
|
||||
if dbURL == "" {
|
||||
|
||||
@@ -6,6 +6,7 @@ import (
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
||||
)
|
||||
@@ -67,3 +68,78 @@ func (database *Database) ExecForTest(
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// GetDB returns the underlying sql.DB connection.
|
||||
func (database *Database) GetDB() *sql.DB {
|
||||
return database.conn
|
||||
}
|
||||
|
||||
// GetOrCreateChannel returns channel id, creating if needed.
|
||||
// Uses INSERT OR IGNORE to avoid TOCTOU races.
|
||||
func (database *Database) GetOrCreateChannel(
|
||||
ctx context.Context,
|
||||
name string,
|
||||
) (int64, error) {
|
||||
now := time.Now()
|
||||
|
||||
_, err := database.conn.ExecContext(ctx,
|
||||
`INSERT OR IGNORE INTO channels
|
||||
(name, created_at, updated_at)
|
||||
VALUES (?, ?, ?)`,
|
||||
name, now, now)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("create channel: %w", err)
|
||||
}
|
||||
|
||||
var channelID int64
|
||||
|
||||
err = database.conn.QueryRowContext(
|
||||
ctx,
|
||||
"SELECT id FROM channels WHERE name = ?",
|
||||
name,
|
||||
).Scan(&channelID)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("get channel: %w", err)
|
||||
}
|
||||
|
||||
return channelID, nil
|
||||
}
|
||||
|
||||
// JoinChannel adds a session to a channel.
|
||||
func (database *Database) JoinChannel(
|
||||
ctx context.Context,
|
||||
channelID, sessionID int64,
|
||||
) error {
|
||||
_, err := database.conn.ExecContext(ctx,
|
||||
`INSERT OR IGNORE INTO channel_members
|
||||
(channel_id, session_id, joined_at)
|
||||
VALUES (?, ?, ?)`,
|
||||
channelID, sessionID, time.Now())
|
||||
if err != nil {
|
||||
return fmt.Errorf("join channel: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// HasChannelInvite checks if a session has been invited
|
||||
// to a channel.
|
||||
func (database *Database) HasChannelInvite(
|
||||
ctx context.Context,
|
||||
channelID, sessionID int64,
|
||||
) (bool, error) {
|
||||
var count int
|
||||
|
||||
err := database.conn.QueryRowContext(ctx,
|
||||
`SELECT COUNT(*) FROM channel_invites
|
||||
WHERE channel_id = ? AND session_id = ?`,
|
||||
channelID, sessionID,
|
||||
).Scan(&count)
|
||||
if err != nil {
|
||||
return false, fmt.Errorf(
|
||||
"check invite: %w", err,
|
||||
)
|
||||
}
|
||||
|
||||
return count > 0, nil
|
||||
}
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
package db_test
|
||||
|
||||
import (
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
"sneak.berlin/go/neoirc/internal/db"
|
||||
)
|
||||
|
||||
func TestMain(m *testing.M) {
|
||||
db.SetBcryptCost(bcrypt.MinCost)
|
||||
os.Exit(m.Run())
|
||||
}
|
||||
@@ -320,29 +320,6 @@ type ClientHostInfo struct {
|
||||
Hostname string
|
||||
}
|
||||
|
||||
// GetClientHostInfo returns the IP and hostname for a
|
||||
// client.
|
||||
func (database *Database) GetClientHostInfo(
|
||||
ctx context.Context,
|
||||
clientID int64,
|
||||
) (*ClientHostInfo, error) {
|
||||
var info ClientHostInfo
|
||||
|
||||
err := database.conn.QueryRowContext(
|
||||
ctx,
|
||||
`SELECT ip, hostname
|
||||
FROM clients WHERE id = ?`,
|
||||
clientID,
|
||||
).Scan(&info.IP, &info.Hostname)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf(
|
||||
"get client host info: %w", err,
|
||||
)
|
||||
}
|
||||
|
||||
return &info, nil
|
||||
}
|
||||
|
||||
// SetSessionOper sets the is_oper flag on a session.
|
||||
func (database *Database) SetSessionOper(
|
||||
ctx context.Context,
|
||||
@@ -433,54 +410,6 @@ func (database *Database) GetChannelByName(
|
||||
return channelID, nil
|
||||
}
|
||||
|
||||
// GetOrCreateChannel returns channel id, creating if needed.
|
||||
// Uses INSERT OR IGNORE to avoid TOCTOU races.
|
||||
func (database *Database) GetOrCreateChannel(
|
||||
ctx context.Context,
|
||||
name string,
|
||||
) (int64, error) {
|
||||
now := time.Now()
|
||||
|
||||
_, err := database.conn.ExecContext(ctx,
|
||||
`INSERT OR IGNORE INTO channels
|
||||
(name, created_at, updated_at)
|
||||
VALUES (?, ?, ?)`,
|
||||
name, now, now)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("create channel: %w", err)
|
||||
}
|
||||
|
||||
var channelID int64
|
||||
|
||||
err = database.conn.QueryRowContext(
|
||||
ctx,
|
||||
"SELECT id FROM channels WHERE name = ?",
|
||||
name,
|
||||
).Scan(&channelID)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("get channel: %w", err)
|
||||
}
|
||||
|
||||
return channelID, nil
|
||||
}
|
||||
|
||||
// JoinChannel adds a session to a channel.
|
||||
func (database *Database) JoinChannel(
|
||||
ctx context.Context,
|
||||
channelID, sessionID int64,
|
||||
) error {
|
||||
_, err := database.conn.ExecContext(ctx,
|
||||
`INSERT OR IGNORE INTO channel_members
|
||||
(channel_id, session_id, joined_at)
|
||||
VALUES (?, ?, ?)`,
|
||||
channelID, sessionID, time.Now())
|
||||
if err != nil {
|
||||
return fmt.Errorf("join channel: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Errors that CreateOrJoinChannel refuses a join with.
|
||||
var (
|
||||
ErrBannedFromChannel = errors.New("banned from channel")
|
||||
@@ -1127,23 +1056,6 @@ func (database *Database) GetChannelMemberIDs(
|
||||
return scanInt64s(rows)
|
||||
}
|
||||
|
||||
// GetSessionChannelIDs returns channel IDs for a session.
|
||||
func (database *Database) GetSessionChannelIDs(
|
||||
ctx context.Context,
|
||||
sessionID int64,
|
||||
) ([]int64, error) {
|
||||
rows, err := database.conn.QueryContext(ctx,
|
||||
`SELECT channel_id FROM channel_members
|
||||
WHERE session_id = ?`, sessionID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf(
|
||||
"get session channel ids: %w", err,
|
||||
)
|
||||
}
|
||||
|
||||
return scanInt64s(rows)
|
||||
}
|
||||
|
||||
// InsertMessage stores a message and returns its DB ID.
|
||||
// toSessionID is the session a DM or INVITE is sent to and
|
||||
// toChannelID the channel a channel message is sent to;
|
||||
@@ -2460,28 +2372,6 @@ func (database *Database) AddChannelInvite(
|
||||
return nil
|
||||
}
|
||||
|
||||
// HasChannelInvite checks if a session has been invited
|
||||
// to a channel.
|
||||
func (database *Database) HasChannelInvite(
|
||||
ctx context.Context,
|
||||
channelID, sessionID int64,
|
||||
) (bool, error) {
|
||||
var count int
|
||||
|
||||
err := database.conn.QueryRowContext(ctx,
|
||||
`SELECT COUNT(*) FROM channel_invites
|
||||
WHERE channel_id = ? AND session_id = ?`,
|
||||
channelID, sessionID,
|
||||
).Scan(&count)
|
||||
if err != nil {
|
||||
return false, fmt.Errorf(
|
||||
"check invite: %w", err,
|
||||
)
|
||||
}
|
||||
|
||||
return count > 0, nil
|
||||
}
|
||||
|
||||
// --- Tier 2: Secret (+s) ---
|
||||
|
||||
// IsChannelSecret checks if a channel has +s mode.
|
||||
|
||||
@@ -125,7 +125,7 @@ func TestCreateSessionStoresIP(t *testing.T) {
|
||||
database := setupTestDB(t)
|
||||
ctx := t.Context()
|
||||
|
||||
sessionID, clientID, _, err := database.CreateSession(
|
||||
sessionID, _, _, err := database.CreateSession(
|
||||
ctx, "ipuser", "ident", "host.example.com",
|
||||
"192.168.1.42",
|
||||
)
|
||||
@@ -147,8 +147,8 @@ func TestCreateSessionStoresIP(t *testing.T) {
|
||||
)
|
||||
}
|
||||
|
||||
clientInfo, err := database.GetClientHostInfo(
|
||||
ctx, clientID,
|
||||
clientInfo, err := database.GetLatestClientForSession(
|
||||
ctx, sessionID,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
@@ -169,19 +169,6 @@ func TestCreateSessionStoresIP(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetClientHostInfoNotFound(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
database := setupTestDB(t)
|
||||
|
||||
_, err := database.GetClientHostInfo(
|
||||
t.Context(), 99999,
|
||||
)
|
||||
if err == nil {
|
||||
t.Fatal("expected error for nonexistent client")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetSessionHostInfoNotFound(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
package db
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"log/slog"
|
||||
)
|
||||
|
||||
// NewTestDatabaseFromConn creates a Database wrapping an
|
||||
// existing *sql.DB connection. Intended for integration
|
||||
// tests in other packages.
|
||||
func NewTestDatabaseFromConn(conn *sql.DB) *Database {
|
||||
return &Database{ //nolint:exhaustruct
|
||||
conn: conn,
|
||||
log: slog.Default(),
|
||||
}
|
||||
}
|
||||
|
||||
// RunMigrations applies all schema migrations. Exposed
|
||||
// for integration tests in other packages.
|
||||
func (database *Database) RunMigrations(
|
||||
ctx context.Context,
|
||||
) error {
|
||||
return database.runMigrations(ctx)
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
// Package dbtest gives each test a database of its own. Only tests
|
||||
// may import it.
|
||||
// Package dbtest gives each test a database of its own and runs raw
|
||||
// SQL on it. Only tests may import it.
|
||||
package dbtest
|
||||
|
||||
import (
|
||||
@@ -37,3 +37,23 @@ func NewURL(tb testing.TB) string {
|
||||
|
||||
return dbURL
|
||||
}
|
||||
|
||||
// Exec runs one raw SQL statement on the database at dbURL, over a
|
||||
// connection of its own. A test uses it for what the methods of
|
||||
// db.Database cannot do, such as creating a trigger that makes a
|
||||
// write fail.
|
||||
func Exec(tb testing.TB, dbURL, statement string) {
|
||||
tb.Helper()
|
||||
|
||||
pool, err := sql.Open("sqlite", dbURL)
|
||||
if err != nil {
|
||||
tb.Fatalf("open test database: %v", err)
|
||||
}
|
||||
|
||||
defer func() { _ = pool.Close() }()
|
||||
|
||||
_, err = pool.ExecContext(tb.Context(), statement)
|
||||
if err != nil {
|
||||
tb.Fatalf("run %q: %v", statement, err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -188,7 +188,7 @@ func (hdlr *Handlers) handleCreateSession(
|
||||
|
||||
var payload createRequest
|
||||
|
||||
err := json.NewDecoder(request.Body).Decode(&payload)
|
||||
err := decodeJSON(request, &payload)
|
||||
if err != nil {
|
||||
hdlr.respondError(
|
||||
writer, request,
|
||||
@@ -925,7 +925,7 @@ func (hdlr *Handlers) HandleSendCommand() http.HandlerFunc {
|
||||
|
||||
var payload commandRequest
|
||||
|
||||
err := json.NewDecoder(request.Body).Decode(&payload)
|
||||
err := decodeJSON(request, &payload)
|
||||
if err != nil {
|
||||
hdlr.respondError(
|
||||
writer, request,
|
||||
@@ -994,7 +994,7 @@ func (hdlr *Handlers) dispatchCommand(
|
||||
hdlr.handlePrivmsg(
|
||||
writer, request,
|
||||
sessionID, clientID, nick,
|
||||
command, target, body, meta, bodyLines,
|
||||
command, target, body, meta,
|
||||
)
|
||||
case irc.CmdJoin:
|
||||
hdlr.handleJoin(
|
||||
@@ -1139,8 +1139,18 @@ func (hdlr *Handlers) handlePrivmsg(
|
||||
nick, command, target string,
|
||||
body json.RawMessage,
|
||||
meta json.RawMessage,
|
||||
bodyLines func() []string,
|
||||
) {
|
||||
lines, ok := checkBodyAndMeta(body, meta)
|
||||
if !ok {
|
||||
hdlr.respondError(
|
||||
writer, request,
|
||||
"invalid request body",
|
||||
http.StatusBadRequest,
|
||||
)
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
if target == "" {
|
||||
hdlr.enqueueNumeric(
|
||||
request.Context(), clientID,
|
||||
@@ -1155,7 +1165,6 @@ func (hdlr *Handlers) handlePrivmsg(
|
||||
return
|
||||
}
|
||||
|
||||
lines := bodyLines()
|
||||
if len(lines) == 0 {
|
||||
hdlr.enqueueNumeric(
|
||||
request.Context(), clientID,
|
||||
@@ -1189,6 +1198,44 @@ func (hdlr *Handlers) handlePrivmsg(
|
||||
)
|
||||
}
|
||||
|
||||
// checkBodyAndMeta returns the lines in body. It returns false
|
||||
// when body is present and is not an array of strings, or meta
|
||||
// is present and is not an object. Each line is decoded as any
|
||||
// because decoding into []string turns a null line into "". A
|
||||
// null body or meta decodes without an error into nil.
|
||||
func checkBodyAndMeta(body, meta json.RawMessage) ([]string, bool) {
|
||||
var lines []string
|
||||
|
||||
if body != nil {
|
||||
var values []any
|
||||
|
||||
err := json.Unmarshal(body, &values)
|
||||
if err != nil || values == nil {
|
||||
return nil, false
|
||||
}
|
||||
|
||||
for _, value := range values {
|
||||
line, isString := value.(string)
|
||||
if !isString {
|
||||
return nil, false
|
||||
}
|
||||
|
||||
lines = append(lines, line)
|
||||
}
|
||||
}
|
||||
|
||||
if meta != nil {
|
||||
var fields map[string]any
|
||||
|
||||
err := json.Unmarshal(meta, &fields)
|
||||
if err != nil || fields == nil {
|
||||
return nil, false
|
||||
}
|
||||
}
|
||||
|
||||
return lines, true
|
||||
}
|
||||
|
||||
// respondIRCError enqueues a numeric error reply, notifies
|
||||
// the broker, and sends HTTP 200 with {"status":"error"}.
|
||||
func (hdlr *Handlers) respondIRCError(
|
||||
@@ -3191,7 +3238,7 @@ func (hdlr *Handlers) handleWho(
|
||||
// 315 RPL_ENDOFWHO (empty result)
|
||||
hdlr.enqueueNumeric(
|
||||
ctx, clientID, irc.RplEndOfWho, nick,
|
||||
[]string{target},
|
||||
[]string{channel},
|
||||
"End of /WHO list",
|
||||
)
|
||||
hdlr.broker.Notify(sessionID)
|
||||
|
||||
+311
-52
@@ -8,10 +8,12 @@ import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"maps"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"os"
|
||||
"reflect"
|
||||
"slices"
|
||||
"strconv"
|
||||
"strings"
|
||||
@@ -45,22 +47,25 @@ import (
|
||||
const templateDBURL = "file:template?mode=memory&cache=shared"
|
||||
|
||||
func TestMain(m *testing.M) {
|
||||
db.SetBcryptCost(bcrypt.MinCost)
|
||||
template := fx.New(
|
||||
fx.NopLogger,
|
||||
fx.Supply(
|
||||
&globals.Globals{},
|
||||
&config.Config{DBURL: templateDBURL},
|
||||
),
|
||||
fx.Provide(logger.New, newTestDB),
|
||||
// fx makes the database only if something asks for it.
|
||||
fx.Invoke(func(*db.Database) {}),
|
||||
)
|
||||
|
||||
template, err := sql.Open("sqlite", templateDBURL)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
err = db.NewTestDatabaseFromConn(template).
|
||||
RunMigrations(context.Background())
|
||||
err := template.Start(context.Background())
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
code := m.Run()
|
||||
|
||||
_ = template.Close()
|
||||
_ = template.Stop(context.Background())
|
||||
|
||||
os.Exit(code)
|
||||
}
|
||||
@@ -135,6 +140,7 @@ type testServer struct {
|
||||
t *testing.T
|
||||
fxApp *fxtest.App
|
||||
broker *broker.Broker
|
||||
dbURL string
|
||||
database *db.Database
|
||||
handlers *handlers.Handlers
|
||||
}
|
||||
@@ -229,6 +235,7 @@ func newTestServerWith(
|
||||
t: t,
|
||||
fxApp: app,
|
||||
broker: brk,
|
||||
dbURL: dbURL,
|
||||
database: database,
|
||||
handlers: hdlr,
|
||||
}
|
||||
@@ -795,6 +802,104 @@ func TestCreateSessionMalformed(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func (tserver *testServer) postBody(
|
||||
path, token, body string,
|
||||
) (int, map[string]any) {
|
||||
tserver.t.Helper()
|
||||
|
||||
resp, err := doRequestAuth(
|
||||
tserver.t, http.MethodPost, tserver.url(path), token,
|
||||
strings.NewReader(body),
|
||||
)
|
||||
if err != nil {
|
||||
tserver.t.Fatalf("post %s: %v", path, err)
|
||||
}
|
||||
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
var result map[string]any
|
||||
|
||||
_ = json.NewDecoder(resp.Body).Decode(&result)
|
||||
|
||||
return resp.StatusCode, result
|
||||
}
|
||||
|
||||
// TestRequestBodyLimit sends each endpoint a small valid JSON value
|
||||
// followed by other bytes. Only whitespace may follow the value, and
|
||||
// the whole body counts towards MAX_MESSAGE_SIZE.
|
||||
func TestRequestBodyLimit(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const (
|
||||
maxMessageSize = 4096 // the default MAX_MESSAGE_SIZE
|
||||
nick = "alice_bodylimit"
|
||||
)
|
||||
|
||||
endpoints := []struct {
|
||||
name, path, value string
|
||||
acceptedStatus int
|
||||
}{
|
||||
{
|
||||
"create session", apiSession,
|
||||
`{"nick":"bob_bodylimit"}`,
|
||||
http.StatusCreated,
|
||||
},
|
||||
{
|
||||
"login", "/api/v1/login",
|
||||
`{"nick":"` + nick + `","password":"` + testPassword + `"}`,
|
||||
http.StatusOK,
|
||||
},
|
||||
{
|
||||
"post message", apiMessages,
|
||||
`{"command":"PING"}`,
|
||||
http.StatusOK,
|
||||
},
|
||||
}
|
||||
|
||||
for _, endpoint := range endpoints {
|
||||
t.Run(endpoint.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tserver := newTestServer(t)
|
||||
token := tserver.createSession(nick)
|
||||
|
||||
tserver.setPassword(nick)
|
||||
|
||||
bytesToLimit := maxMessageSize - len(endpoint.value)
|
||||
|
||||
for _, trailing := range []string{
|
||||
strings.Repeat(" ", bytesToLimit+1),
|
||||
strings.Repeat("x", bytesToLimit+1),
|
||||
"x",
|
||||
"{}",
|
||||
} {
|
||||
status, result := tserver.postBody(
|
||||
endpoint.path, token, endpoint.value+trailing,
|
||||
)
|
||||
if status != http.StatusBadRequest ||
|
||||
result["error"] != "invalid request body" {
|
||||
t.Errorf(
|
||||
"%d bytes of %.10q after the value: expected "+
|
||||
"400 invalid request body, got %d: %v",
|
||||
len(trailing), trailing, status, result,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
status, result := tserver.postBody(
|
||||
endpoint.path, token,
|
||||
endpoint.value+strings.Repeat(" ", bytesToLimit),
|
||||
)
|
||||
if status != endpoint.acceptedStatus {
|
||||
t.Errorf(
|
||||
"body of exactly the limit: expected %d, got %d: %v",
|
||||
endpoint.acceptedStatus, status, result,
|
||||
)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAuthNoCookie(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -999,6 +1104,8 @@ func TestChannelMessage(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestMessageMissingBody checks that a PRIVMSG with no body,
|
||||
// or an empty one, gets ERR_NOTEXTTOSEND.
|
||||
func TestMessageMissingBody(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -1013,20 +1120,25 @@ func TestMessageMissingBody(t *testing.T) {
|
||||
|
||||
_, lastID := tserver.pollMessages(token, 0)
|
||||
|
||||
status, _ := tserver.sendCommand(token, map[string]any{
|
||||
commandKey: privmsgCmd, toKey: channel,
|
||||
})
|
||||
if status != http.StatusOK {
|
||||
t.Fatalf("expected 200, got %d", status)
|
||||
}
|
||||
for _, request := range []map[string]any{
|
||||
{commandKey: privmsgCmd, toKey: channel},
|
||||
{commandKey: privmsgCmd, toKey: channel, bodyKey: []string{}},
|
||||
} {
|
||||
status, _ := tserver.sendCommand(token, request)
|
||||
if status != http.StatusOK {
|
||||
t.Fatalf("%v: expected 200, got %d", request, status)
|
||||
}
|
||||
|
||||
msgs, _ := tserver.pollMessages(token, lastID)
|
||||
var msgs []map[string]any
|
||||
|
||||
if !findNumeric(msgs, "412") {
|
||||
t.Fatalf(
|
||||
"expected ERR_NOTEXTTOSEND (412), got %v",
|
||||
msgs,
|
||||
)
|
||||
msgs, lastID = tserver.pollMessages(token, lastID)
|
||||
|
||||
if !findNumeric(msgs, "412") {
|
||||
t.Fatalf(
|
||||
"%v: expected ERR_NOTEXTTOSEND (412), got %v",
|
||||
request, msgs,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1056,6 +1168,132 @@ func TestMessageMissingTo(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestMessageInvalidBodyOrMeta checks that a PRIVMSG or
|
||||
// NOTICE, to a channel or a nick, whose body is not an array
|
||||
// of strings or whose meta is not an object gets 400 and
|
||||
// reaches nobody.
|
||||
func TestMessageInvalidBodyOrMeta(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
fields map[string]any
|
||||
}{
|
||||
{"null line", map[string]any{bodyKey: []any{"hi", nil}}},
|
||||
{"number line", map[string]any{bodyKey: []any{"hi", 1}}},
|
||||
{"object line", map[string]any{bodyKey: []any{map[string]any{}}}},
|
||||
{"null body", map[string]any{bodyKey: nil}},
|
||||
{"object body", map[string]any{bodyKey: map[string]any{}}},
|
||||
{"null meta", map[string]any{bodyKey: []string{"hi"}, metaKey: nil}},
|
||||
{"array meta", map[string]any{bodyKey: []string{"hi"}, metaKey: []string{}}},
|
||||
{"string meta", map[string]any{bodyKey: []string{"hi"}, metaKey: "hi"}},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const channel = "#badmsg"
|
||||
|
||||
tserver := newTestServer(t)
|
||||
aliceToken := tserver.createSession("alice_badmsg")
|
||||
bobToken := tserver.createSession("bob_badmsg")
|
||||
|
||||
tserver.sendCommand(aliceToken, map[string]any{
|
||||
commandKey: joinCmd, toKey: channel,
|
||||
})
|
||||
tserver.sendCommand(bobToken, map[string]any{
|
||||
commandKey: joinCmd, toKey: channel,
|
||||
})
|
||||
|
||||
_, bobLastID := tserver.pollMessages(bobToken, 0)
|
||||
|
||||
for _, command := range []string{privmsgCmd, irc.CmdNotice} {
|
||||
for _, target := range []string{channel, "bob_badmsg"} {
|
||||
request := map[string]any{
|
||||
commandKey: command, toKey: target,
|
||||
}
|
||||
maps.Copy(request, tc.fields)
|
||||
|
||||
status, result := tserver.sendCommand(
|
||||
aliceToken, request,
|
||||
)
|
||||
if status != http.StatusBadRequest ||
|
||||
result["error"] != "invalid request body" {
|
||||
t.Errorf(
|
||||
"%s to %s: expected 400 invalid "+
|
||||
"request body, got %d: %v",
|
||||
command, target, status, result,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
msgs, _ := tserver.pollMessages(bobToken, bobLastID)
|
||||
if len(msgs) != 0 {
|
||||
t.Fatalf("expected no messages, bob got %v", msgs)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestMessageRelaysBodyAndMeta checks that a PRIVMSG or
|
||||
// NOTICE, to a channel or a nick, reaches its recipient with
|
||||
// body and meta as sent.
|
||||
func TestMessageRelaysBodyAndMeta(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const channel = "#relaymsg"
|
||||
|
||||
tserver := newTestServer(t)
|
||||
aliceToken := tserver.createSession("alice_relaymsg")
|
||||
bobToken := tserver.createSession("bob_relaymsg")
|
||||
|
||||
tserver.sendCommand(aliceToken, map[string]any{
|
||||
commandKey: joinCmd, toKey: channel,
|
||||
})
|
||||
tserver.sendCommand(bobToken, map[string]any{
|
||||
commandKey: joinCmd, toKey: channel,
|
||||
})
|
||||
|
||||
_, bobLastID := tserver.pollMessages(bobToken, 0)
|
||||
|
||||
body := []any{"line one", ""}
|
||||
meta := map[string]any{"sig": "abc", "alg": "ed25519"}
|
||||
|
||||
for _, command := range []string{privmsgCmd, irc.CmdNotice} {
|
||||
for _, target := range []string{channel, "bob_relaymsg"} {
|
||||
status, result := tserver.sendCommand(
|
||||
aliceToken,
|
||||
map[string]any{
|
||||
commandKey: command, toKey: target,
|
||||
bodyKey: body, metaKey: meta,
|
||||
},
|
||||
)
|
||||
if status != http.StatusOK {
|
||||
t.Fatalf(
|
||||
"%s to %s: expected 200, got %d: %v",
|
||||
command, target, status, result,
|
||||
)
|
||||
}
|
||||
|
||||
var msgs []map[string]any
|
||||
|
||||
msgs, bobLastID = tserver.pollMessages(
|
||||
bobToken, bobLastID,
|
||||
)
|
||||
if len(msgs) != 1 ||
|
||||
msgs[0][commandKey] != command ||
|
||||
!reflect.DeepEqual(msgs[0][bodyKey], body) ||
|
||||
!reflect.DeepEqual(msgs[0][metaKey], meta) {
|
||||
t.Fatalf(
|
||||
"%s to %s: bob got %v", command, target, msgs,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestNonMemberCannotSend(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -1527,9 +1765,7 @@ func checkQuitRace(
|
||||
firstToken := tserver.createSession(nick)
|
||||
observerToken := tserver.createSession("raceobserver")
|
||||
|
||||
tserver.sendCommand(firstToken, map[string]any{
|
||||
commandKey: irc.CmdPass, bodyKey: []string{testPassword},
|
||||
})
|
||||
tserver.setPassword(nick)
|
||||
|
||||
tokens := []string{firstToken, tserver.login(nick)}
|
||||
|
||||
@@ -1579,9 +1815,7 @@ func TestLogoutOfOneClientKeepsSession(t *testing.T) {
|
||||
firstToken := tserver.createSession(nick)
|
||||
observerToken := tserver.createSession("logoutobserver")
|
||||
|
||||
tserver.sendCommand(firstToken, map[string]any{
|
||||
commandKey: irc.CmdPass, bodyKey: []string{testPassword},
|
||||
})
|
||||
tserver.setPassword(nick)
|
||||
|
||||
secondToken := tserver.login(nick)
|
||||
|
||||
@@ -1651,15 +1885,12 @@ func TestFailedLogoutChangesNothing(t *testing.T) {
|
||||
|
||||
_, lastID := tserver.pollMessages(observerToken, 0)
|
||||
|
||||
_, err := tserver.database.GetDB().ExecContext(t.Context(),
|
||||
dbtest.Exec(t, tserver.dbURL,
|
||||
`CREATE TRIGGER keep_sessions
|
||||
BEFORE DELETE ON sessions
|
||||
BEGIN
|
||||
SELECT RAISE(ABORT, 'sessions are kept');
|
||||
END`)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
resp, err := doRequestAuth(
|
||||
t, http.MethodPost, tserver.url(apiLogout), token, nil,
|
||||
@@ -1893,6 +2124,24 @@ func (tserver *testServer) longPoll(
|
||||
return result.Messages, nil
|
||||
}
|
||||
|
||||
// setPassword gives the session nick the password testPassword
|
||||
// without sending PASS. It hashes at bcrypt.MinCost, and a login
|
||||
// compares at the cost stored in the hash, so both are fast.
|
||||
func (tserver *testServer) setPassword(nick string) {
|
||||
tserver.t.Helper()
|
||||
|
||||
hash, err := bcrypt.GenerateFromPassword(
|
||||
[]byte(testPassword), bcrypt.MinCost,
|
||||
)
|
||||
if err != nil {
|
||||
tserver.t.Fatalf("hash password: %v", err)
|
||||
}
|
||||
|
||||
dbtest.Exec(tserver.t, tserver.dbURL,
|
||||
"UPDATE sessions SET password_hash = '"+string(hash)+
|
||||
"' WHERE nick = '"+nick+"'")
|
||||
}
|
||||
|
||||
// login logs in to the session nick with testPassword and
|
||||
// returns the new client's token.
|
||||
func (tserver *testServer) login(nick string) string {
|
||||
@@ -3500,13 +3749,8 @@ func TestLoginValid(t *testing.T) {
|
||||
|
||||
tserver := newTestServer(t)
|
||||
|
||||
// Create session and set password via PASS command.
|
||||
token := tserver.createSession("loginuser")
|
||||
|
||||
tserver.sendCommand(token, map[string]any{
|
||||
commandKey: irc.CmdPass,
|
||||
bodyKey: []string{testPassword},
|
||||
})
|
||||
tserver.createSession("loginuser")
|
||||
tserver.setPassword("loginuser")
|
||||
|
||||
// Login with nick + password.
|
||||
loginBody, err := json.Marshal(map[string]string{
|
||||
@@ -3570,13 +3814,8 @@ func TestLoginWrongPassword(t *testing.T) {
|
||||
|
||||
tserver := newTestServer(t)
|
||||
|
||||
// Create session and set password via PASS command.
|
||||
token := tserver.createSession("wrongpwuser")
|
||||
|
||||
tserver.sendCommand(token, map[string]any{
|
||||
commandKey: irc.CmdPass,
|
||||
bodyKey: []string{"correctpass1"},
|
||||
})
|
||||
tserver.createSession("wrongpwuser")
|
||||
tserver.setPassword("wrongpwuser")
|
||||
|
||||
postJSONExpectStatus(
|
||||
t, tserver, "/api/v1/login",
|
||||
@@ -3904,6 +4143,31 @@ func assertWhoReplyUsername(
|
||||
)
|
||||
}
|
||||
|
||||
func TestWhoUnknownChannelEndReplyAddsHash(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tserver := newTestServer(t)
|
||||
|
||||
token := tserver.createSession("whoasker")
|
||||
|
||||
_, lastID := tserver.pollMessages(token, 0)
|
||||
|
||||
msgs, _ := sendAndPoll(tserver, token, lastID, map[string]any{
|
||||
commandKey: irc.CmdWho,
|
||||
toKey: "nosuch",
|
||||
})
|
||||
|
||||
endOfWho := findNumericWithParams(msgs, "315")
|
||||
if endOfWho == nil {
|
||||
t.Fatalf("expected RPL_ENDOFWHO (315), got %v", msgs)
|
||||
}
|
||||
|
||||
params := getNumericParams(endOfWho)
|
||||
if !slices.Equal(params, []string{"#nosuch"}) {
|
||||
t.Fatalf("expected params [#nosuch], got %v", params)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSessionUsernameDefault(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -4022,13 +4286,8 @@ func TestLoginRateLimitAllowsNormalUse(t *testing.T) {
|
||||
|
||||
tserver := newTestServer(t)
|
||||
|
||||
// Create session and set password via PASS command.
|
||||
token := tserver.createSession("normaluser")
|
||||
|
||||
tserver.sendCommand(token, map[string]any{
|
||||
commandKey: irc.CmdPass,
|
||||
bodyKey: []string{testPassword},
|
||||
})
|
||||
tserver.createSession("normaluser")
|
||||
tserver.setPassword("normaluser")
|
||||
|
||||
// A single login should succeed without rate limiting.
|
||||
loginBody, err := json.Marshal(map[string]string{
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
@@ -55,7 +54,7 @@ func (hdlr *Handlers) handleLogin(
|
||||
|
||||
var payload loginRequest
|
||||
|
||||
err := json.NewDecoder(request.Body).Decode(&payload)
|
||||
err := decodeJSON(request, &payload)
|
||||
if err != nil {
|
||||
hdlr.respondError(
|
||||
writer, request,
|
||||
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"io"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"time"
|
||||
@@ -159,6 +160,18 @@ func (hdlr *Handlers) respondError(
|
||||
)
|
||||
}
|
||||
|
||||
// decodeJSON reads the whole request body and decodes it into dest.
|
||||
// It fails if the body is larger than the http.MaxBytesReader limit,
|
||||
// or holds anything other than one JSON value and whitespace.
|
||||
func decodeJSON(request *http.Request, dest any) error {
|
||||
body, err := io.ReadAll(request.Body)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return json.Unmarshal(body, dest)
|
||||
}
|
||||
|
||||
func (hdlr *Handlers) idleTimeout() time.Duration {
|
||||
raw := hdlr.params.Config.SessionIdleTimeout
|
||||
if raw == "" {
|
||||
|
||||
@@ -1227,9 +1227,12 @@ func (c *Conn) handlePassPostReg(
|
||||
return
|
||||
}
|
||||
|
||||
// The IRC listener cannot add a connection to an existing
|
||||
// session; only the HTTP API login can.
|
||||
c.sendFromServer("NOTICE", c.currentNick(),
|
||||
"Password set. You can reconnect using "+
|
||||
"PASS <password> with your nick.",
|
||||
"Password set. Another client can log in to this "+
|
||||
"session over the HTTP API: POST /api/v1/login "+
|
||||
"with your nick and this password.",
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
@@ -8,6 +8,8 @@ import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
||||
"sneak.berlin/go/neoirc/internal/ircserver"
|
||||
"sneak.berlin/go/neoirc/internal/service"
|
||||
)
|
||||
@@ -583,8 +585,10 @@ func ownSessionCopies(
|
||||
|
||||
// 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
|
||||
// client to her session with a password, as POST /api/v1/login
|
||||
// does. It stores that password without sending PASS. It hashes
|
||||
// at bcrypt.MinCost, and a login compares at the cost stored in
|
||||
// the hash, so both are fast. It returns her connection, bob's
|
||||
// connection, her session and her HTTP API client.
|
||||
func aliceWithHTTPClient(
|
||||
t *testing.T, env *testEnv,
|
||||
@@ -594,15 +598,24 @@ func aliceWithHTTPClient(
|
||||
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")
|
||||
|
||||
hash, err := bcrypt.GenerateFromPassword(
|
||||
[]byte(password), bcrypt.MinCost,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("hash password: %v", err)
|
||||
}
|
||||
|
||||
dbtest.Exec(t, env.dbURL,
|
||||
"UPDATE sessions SET password_hash = '"+string(hash)+
|
||||
"' WHERE nick = 'alice'")
|
||||
|
||||
sessionID, httpClientID, _, err := env.database.LoginUser(
|
||||
t.Context(), "alice", password, "127.0.0.1", "localhost",
|
||||
)
|
||||
|
||||
@@ -32,14 +32,9 @@ import (
|
||||
|
||||
const testTimeout = 5 * time.Second
|
||||
|
||||
func TestMain(m *testing.M) {
|
||||
db.SetBcryptCost(4)
|
||||
|
||||
os.Exit(m.Run())
|
||||
}
|
||||
|
||||
// testEnv holds the shared test infrastructure.
|
||||
type testEnv struct {
|
||||
dbURL string
|
||||
database *db.Database
|
||||
brk *broker.Broker
|
||||
cfg *config.Config
|
||||
@@ -110,34 +105,27 @@ func newTestEnvWithResolver(
|
||||
) *testEnv {
|
||||
t.Helper()
|
||||
|
||||
conn, err := sql.Open("sqlite", dbtest.NewURL(t))
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
dbURL := dbtest.NewURL(t)
|
||||
lifecycle := fxtest.NewLifecycle(t)
|
||||
|
||||
t.Cleanup(func() {
|
||||
err := conn.Close()
|
||||
if err != nil {
|
||||
t.Logf("close db: %v", err)
|
||||
}
|
||||
dbLog, err := logger.New(lifecycle, logger.Params{
|
||||
Globals: &globals.Globals{},
|
||||
})
|
||||
|
||||
conn.SetMaxOpenConns(1)
|
||||
|
||||
_, err = conn.ExecContext(
|
||||
t.Context(), "PRAGMA foreign_keys = ON",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("pragma: %v", err)
|
||||
t.Fatalf("new logger: %v", err)
|
||||
}
|
||||
|
||||
database := db.NewTestDatabaseFromConn(conn)
|
||||
|
||||
err = database.RunMigrations(t.Context())
|
||||
database, err := db.New(lifecycle, db.Params{
|
||||
Logger: dbLog,
|
||||
Config: &config.Config{DBURL: dbURL},
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("migrate: %v", err)
|
||||
t.Fatalf("new database: %v", err)
|
||||
}
|
||||
|
||||
lifecycle.RequireStart()
|
||||
t.Cleanup(lifecycle.RequireStop)
|
||||
|
||||
brk := broker.New()
|
||||
|
||||
log := slog.New(slog.NewTextHandler(
|
||||
@@ -161,6 +149,7 @@ func newTestEnvWithResolver(
|
||||
t.Cleanup(srv.Stop)
|
||||
|
||||
return &testEnv{
|
||||
dbURL: dbURL,
|
||||
database: database,
|
||||
brk: brk,
|
||||
cfg: cfg,
|
||||
@@ -929,12 +918,7 @@ func quitSeenByPeers(t *testing.T, quit string) (string, []string) {
|
||||
t.Fatalf("create peer session: %v", err)
|
||||
}
|
||||
|
||||
channelID, err := env.database.GetChannelByName(ctx, "#bye")
|
||||
if err != nil {
|
||||
t.Fatalf("get channel: %v", err)
|
||||
}
|
||||
|
||||
err = env.database.JoinChannel(ctx, channelID, apiPeerID)
|
||||
_, _, err = env.database.CreateOrJoinChannel(ctx, "#bye", apiPeerID, "")
|
||||
if err != nil {
|
||||
t.Fatalf("join peer: %v", err)
|
||||
}
|
||||
@@ -1005,12 +989,9 @@ func TestStopEndsSessions(t *testing.T) {
|
||||
t.Fatalf("create peer session: %v", err)
|
||||
}
|
||||
|
||||
channelID, err := env.database.GetChannelByName(ctx, "#shut")
|
||||
if err != nil {
|
||||
t.Fatalf("get channel: %v", err)
|
||||
}
|
||||
|
||||
err = env.database.JoinChannel(ctx, channelID, peerID)
|
||||
channelID, _, err := env.database.CreateOrJoinChannel(
|
||||
ctx, "#shut", peerID, "",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("join peer: %v", err)
|
||||
}
|
||||
@@ -1068,11 +1049,16 @@ func TestStopReturnsWhileCleanupIsStuck(t *testing.T) {
|
||||
|
||||
client.register("stuck")
|
||||
|
||||
// The test database has one connection. While the test
|
||||
// holds it, the cleanup's first query waits for it.
|
||||
held, err := env.database.GetDB().Conn(t.Context())
|
||||
// While a connection of the test's own holds a write
|
||||
// transaction, the cleanup's first write waits for it to end.
|
||||
holder, err := sql.Open("sqlite", env.dbURL)
|
||||
if err != nil {
|
||||
t.Fatalf("take the database connection: %v", err)
|
||||
t.Fatalf("open a second database connection: %v", err)
|
||||
}
|
||||
|
||||
_, err = holder.ExecContext(t.Context(), "BEGIN IMMEDIATE")
|
||||
if err != nil {
|
||||
t.Fatalf("begin a write transaction: %v", err)
|
||||
}
|
||||
|
||||
stopped := make(chan struct{})
|
||||
@@ -1088,10 +1074,11 @@ func TestStopReturnsWhileCleanupIsStuck(t *testing.T) {
|
||||
t.Error("Stop did not return while a cleanup was stuck")
|
||||
}
|
||||
|
||||
// Lets the cleanup finish before the database is closed.
|
||||
err = held.Close()
|
||||
// Closing ends the transaction, which lets the cleanup finish
|
||||
// before the database is closed.
|
||||
err = holder.Close()
|
||||
if err != nil {
|
||||
t.Errorf("release the database connection: %v", err)
|
||||
t.Errorf("close the second database connection: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1250,6 +1237,9 @@ func TestAwaySetAndClear(t *testing.T) {
|
||||
assertContains(t, clearLines, " 305 ", "RPL_UNAWAY")
|
||||
}
|
||||
|
||||
// TestHandlePassPostRegistration checks the NOTICE that
|
||||
// confirms PASS after registration. It points to the HTTP API
|
||||
// login, the only way to add a client to an existing session.
|
||||
func TestHandlePassPostRegistration(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -1262,7 +1252,11 @@ func TestHandlePassPostRegistration(t *testing.T) {
|
||||
)
|
||||
|
||||
assertContains(
|
||||
t, lines, "Password set", "password confirmation",
|
||||
t, lines,
|
||||
" NOTICE passuser :Password set. Another client can log "+
|
||||
"in to this session over the HTTP API: "+
|
||||
"POST /api/v1/login with your nick and this password.",
|
||||
"password confirmation",
|
||||
)
|
||||
}
|
||||
|
||||
@@ -1363,14 +1357,11 @@ func TestPassPostRegistrationNotStored(t *testing.T) {
|
||||
|
||||
client.register("failpass")
|
||||
|
||||
_, err := env.database.GetDB().ExecContext(t.Context(),
|
||||
dbtest.Exec(t, env.dbURL,
|
||||
`CREATE TRIGGER refuse_password
|
||||
BEFORE UPDATE OF password_hash ON sessions
|
||||
BEGIN SELECT RAISE(ABORT, 'refused'); END`,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("create trigger: %v", err)
|
||||
}
|
||||
|
||||
client.send("PASS :mypassword123")
|
||||
|
||||
|
||||
@@ -9,7 +9,6 @@ import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"slices"
|
||||
"strings"
|
||||
"sync"
|
||||
@@ -18,7 +17,6 @@ import (
|
||||
|
||||
"go.uber.org/fx"
|
||||
"go.uber.org/fx/fxtest"
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
"sneak.berlin/go/neoirc/internal/broker"
|
||||
"sneak.berlin/go/neoirc/internal/config"
|
||||
"sneak.berlin/go/neoirc/internal/db"
|
||||
@@ -30,14 +28,10 @@ import (
|
||||
"sneak.berlin/go/neoirc/pkg/irc"
|
||||
)
|
||||
|
||||
func TestMain(m *testing.M) {
|
||||
db.SetBcryptCost(bcrypt.MinCost)
|
||||
os.Exit(m.Run())
|
||||
}
|
||||
|
||||
// testEnv holds all dependencies for a service test.
|
||||
type testEnv struct {
|
||||
svc *service.Service
|
||||
dbURL string
|
||||
db *db.Database
|
||||
broker *broker.Broker
|
||||
app *fxtest.App
|
||||
@@ -111,6 +105,7 @@ func newTestEnv(t *testing.T) *testEnv {
|
||||
|
||||
return &testEnv{
|
||||
svc: svc,
|
||||
dbURL: dbURL,
|
||||
db: database,
|
||||
broker: brk,
|
||||
app: app,
|
||||
@@ -940,19 +935,16 @@ func TestSendDirectMessageTargetQuits(t *testing.T) {
|
||||
sid := createSession(ctx, t, env.db, "alice")
|
||||
createSession(ctx, t, env.db, "bob")
|
||||
|
||||
_, err := env.db.GetDB().ExecContext(ctx,
|
||||
dbtest.Exec(t, env.dbURL,
|
||||
`CREATE TRIGGER delete_recipient
|
||||
BEFORE INSERT ON messages
|
||||
BEGIN
|
||||
DELETE FROM sessions WHERE id = NEW.to_session_id;
|
||||
END`)
|
||||
if err != nil {
|
||||
t.Fatalf("create trigger: %v", err)
|
||||
}
|
||||
|
||||
body, _ := json.Marshal([]string{"hi"}) //nolint:errchkjson
|
||||
|
||||
_, err = env.svc.SendDirectMessage(
|
||||
_, err := env.svc.SendDirectMessage(
|
||||
ctx, sid, 0, "alice", irc.CmdPrivmsg, "bob", body, nil,
|
||||
)
|
||||
|
||||
@@ -978,15 +970,12 @@ func TestSendChannelMessageChannelDeleted(t *testing.T) {
|
||||
t.Fatalf("join alice: %v", err)
|
||||
}
|
||||
|
||||
_, err = env.db.GetDB().ExecContext(ctx,
|
||||
dbtest.Exec(t, env.dbURL,
|
||||
`CREATE TRIGGER delete_recipient
|
||||
BEFORE INSERT ON messages
|
||||
BEGIN
|
||||
DELETE FROM channels WHERE id = NEW.to_channel_id;
|
||||
END`)
|
||||
if err != nil {
|
||||
t.Fatalf("create trigger: %v", err)
|
||||
}
|
||||
|
||||
body, _ := json.Marshal([]string{"hi"}) //nolint:errchkjson
|
||||
|
||||
|
||||
+17
-82
@@ -20,7 +20,7 @@ are the fields it can have:
|
||||
- `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 server message.
|
||||
- `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`
|
||||
@@ -60,29 +60,32 @@ A `PRIVMSG` whose `body` has two strings is a two-line message:
|
||||
|
||||
## Files
|
||||
|
||||
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`.
|
||||
|
||||
Commands, in `commands/`:
|
||||
|
||||
- `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`: a user joined a channel.
|
||||
- `PART.json`: a user left a channel.
|
||||
- `QUIT.json`: a user left the server.
|
||||
- `NICK.json`: a user changed nick.
|
||||
- `TOPIC.json`: a channel topic was set.
|
||||
- `MODE.json`: a channel mode was changed.
|
||||
- `KICK.json`: a channel operator removed a user from a channel.
|
||||
- `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`.
|
||||
- `PUBKEY.json`: an announcement of a user's public signing key. The server has
|
||||
no such command. It answers a `PUBKEY` with `ERR_UNKNOWNCOMMAND` (`421`).
|
||||
- `PONG.json`: the answer to a `PING`, which is the HTTP response to it.
|
||||
|
||||
Numeric replies, in `numerics/`:
|
||||
|
||||
- `001.json`: `RPL_WELCOME`, which welcomes a new user.
|
||||
- `001.json`: `RPL_WELCOME`, which welcomes the user.
|
||||
- `002.json`: `RPL_YOURHOST`, the server's name and version.
|
||||
- `003.json`: `RPL_CREATED`, which says when the server was created.
|
||||
- `004.json`: `RPL_MYINFO`, the server's version and its lists of modes.
|
||||
- `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.
|
||||
@@ -96,71 +99,3 @@ Numeric replies, in `numerics/`:
|
||||
- `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.
|
||||
|
||||
## Where the files differ from the HTTP API
|
||||
|
||||
Where a schema file and the HTTP API disagree, the HTTP API is right:
|
||||
|
||||
- `message.json` and the files in `numerics/` put the three-digit code in
|
||||
`command`. They have no `code` field. The HTTP API puts the reply's name in
|
||||
`command` and its number in `code`.
|
||||
- `message.json` allows an object as `body`. The HTTP API reads only arrays of
|
||||
strings. A `PRIVMSG` with an object as `body` gets `ERR_NOTEXTTOSEND` (`412`).
|
||||
- `message.json` says `to` is a channel or a nick. A `WALLOPS` message has `*`
|
||||
there.
|
||||
- `message.json` allows `meta` on every message. The HTTP API keeps a client's
|
||||
`meta` only on a `PRIVMSG` or `NOTICE`.
|
||||
- `message.json` describes signature fields in `meta`. The server never checks a
|
||||
signature.
|
||||
- `message.json` does not describe `meta.hashcash`. The HTTP API reads it in a
|
||||
`PRIVMSG` to a channel with mode `+H`.
|
||||
- `JOIN.json` has no `body`. A client's `JOIN` can carry the channel key in
|
||||
`body`. When a user joins, the `JOIN` event repeats the channel name in
|
||||
`body`.
|
||||
- `JOIN.json` allows a channel name of any length. The server allows at most 63
|
||||
characters after the `#`. It answers a longer name with `ERR_NOSUCHCHANNEL`
|
||||
(`403`).
|
||||
- `KICK.json` puts the kicked nick in `params`. The HTTP API reads a client's
|
||||
`KICK` from `body`: the nick, then an optional reason.
|
||||
- `MODE.json` puts the mode change in `params`. The HTTP API uses `body`
|
||||
instead. A client sends the change and any value as separate strings, such as
|
||||
`"+o"` and `"bob"`. In a `MODE` event, `body` holds the change as one string,
|
||||
such as `"+o bob"`, or as two strings, such as `"+k"` and `"secret"`.
|
||||
- `NOTICE.json` allows `*` as `to`. The server answers a `NOTICE` to `*` with
|
||||
`ERR_NOSUCHNICK` (`401`).
|
||||
- `NOTICE.json` has an example notice from the server to `*`. The server sends
|
||||
no such notice.
|
||||
- `PING.json` and `PONG.json` describe a token that the `PONG` repeats. The HTTP
|
||||
API ignores the `body` of a `PING`. Its answer is the HTTP response
|
||||
`{"command": "PONG", "from": "<server name>"}`.
|
||||
- `PING.json` and `PONG.json` also describe messages between servers. The server
|
||||
does not connect to other IRC servers.
|
||||
- `PUBKEY.json` describes a command the server does not have.
|
||||
- `QUIT.json` says that `QUIT` comes only from the server. A client can send it
|
||||
too, to end its session. A client's `QUIT` can carry a reason in `body`.
|
||||
- `TOPIC.json` says a `TOPIC` without a `body` queries the topic. The HTTP API
|
||||
answers such a `TOPIC` with `ERR_NEEDMOREPARAMS` (`461`).
|
||||
- `TOPIC.json` says an empty array clears the topic. The HTTP API answers `[]`
|
||||
with `ERR_NEEDMOREPARAMS` (`461`). A `body` of `[""]` clears the topic.
|
||||
- `003.json` describes the server's creation date. The HTTP API sends the date
|
||||
the server last started.
|
||||
- `004.json` has example mode lists. The HTTP API sends `ow` as the user modes
|
||||
and `Hbiklmnostv` as the channel modes.
|
||||
- `322.json` says `LIST` gets one reply per channel. The server leaves out a
|
||||
secret channel, one with mode `+s`, unless the user is on it.
|
||||
- `332.json` says `RPL_TOPIC` answers a `TOPIC` query. The HTTP API has no such
|
||||
query. It sends `RPL_TOPIC` after a client sets the topic, and after a `JOIN`
|
||||
to a channel that has one.
|
||||
- `353.json` says `body` lists nicks. The HTTP API lists `nick!user@host` in
|
||||
place of each nick, such as `@op1!op1@host1`.
|
||||
- `353.json` says the first parameter marks a channel as public, private or
|
||||
secret. The server always sends `=`, the mark for a public channel.
|
||||
- `376.json` gives the text as `End of /MOTD command`. The HTTP API adds a full
|
||||
stop.
|
||||
- `401.json` gives the text as `No such nick/channel`. The server sends
|
||||
`No such nick` in answer to a `PRIVMSG` or `NOTICE` to an unknown nick.
|
||||
- `433.json` has an example with `*` as `to`. The HTTP API sends `433` only in
|
||||
answer to a `NICK`, with the user's nick as `to`.
|
||||
|
||||
The HTTP API also accepts some messages that the files do not allow, such as a
|
||||
`JOIN` whose `to` has no `#`.
|
||||
|
||||
@@ -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"] }
|
||||
]
|
||||
|
||||
+20
-32
@@ -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."
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"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"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user