Compare commits
1
Commits
next
..
ce3a989321
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ce3a989321 |
@@ -1,73 +1,55 @@
|
|||||||
# Rules for coding agents
|
# AGENTS.md — Rules for AI Agents
|
||||||
|
|
||||||
This file holds the rules for coding agents working in this repository.
|
## Before Every Commit
|
||||||
`CONVENTIONS.md` defines the architecture. `REPO_POLICIES.md` defines the
|
|
||||||
repository standards. Both are copies of shared documents. Do not edit them
|
|
||||||
here.
|
|
||||||
|
|
||||||
## Before every commit
|
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
|
||||||
|
|
||||||
1. Run `make fmt`.
|
Never run `go test`, `golangci-lint` or `gofmt` directly; use the `make`
|
||||||
2. Run `make check`. It runs the tests and the linter in Docker, then the format
|
targets.
|
||||||
check. All three must pass with no findings.
|
|
||||||
|
|
||||||
Never run `go test`, `golangci-lint` or `gofmt` directly. Use the `make` targets
|
No commit lands on main with lint errors, test failures, or formatting issues.
|
||||||
instead, such as `make test` and `make lint`.
|
|
||||||
|
|
||||||
## Branches and pull requests
|
## Code Style
|
||||||
|
|
||||||
- Never commit to `main` or `next` directly. Every change is a pull request from
|
- Follow CONVENTIONS.md exactly — it defines the architecture
|
||||||
a feature branch into `next`.
|
- All exported types, functions, methods, and vars must have doc comments
|
||||||
- Only the owner merges `next` into `main`.
|
- All packages must have a package doc comment
|
||||||
- A pull request that closes an issue has the title `Description (closes #N)`.
|
- JSON tags use camelCase (not snake_case)
|
||||||
- One logical change per commit.
|
- No magic numbers — use named constants
|
||||||
- Commit messages are in the imperative mood and short.
|
- 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
|
||||||
|
|
||||||
## Code style
|
## Git Workflow
|
||||||
|
|
||||||
- Follow `CONVENTIONS.md`.
|
- **Never commit directly to main** — all changes go on feature branches
|
||||||
- Every package has a package doc comment. Test files need none.
|
- Merge to main only when ready and passing all checks
|
||||||
- Every exported type, function and variable has a doc comment. Test files need
|
- PR titles: `Description (closes #N)` when closing an issue
|
||||||
none.
|
- One logical change per commit
|
||||||
- JSON tags are camelCase. The HTTP API's `last_id`, `pow_token` and
|
- Commit messages: imperative mood, concise
|
||||||
`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
|
## Architecture
|
||||||
|
|
||||||
- The server uses `go.uber.org/fx` for dependency injection.
|
- Dependency injection via Uber fx — all components are fx providers
|
||||||
`cmd/neoircd/main.go` lists its `fx` providers, such as `db.New` and
|
- `internal/` for all application packages — one package per concern
|
||||||
`handlers.New`.
|
- Handlers return `http.HandlerFunc` using the closure pattern
|
||||||
- Application packages live under `internal/`, one package per concern.
|
- Request/response structs defined inside handler closures
|
||||||
- `pkg/irc` holds the IRC command names and numeric reply codes.
|
- Models embed `models.Base` for database access to relation methods
|
||||||
- The `web` package embeds the built web client.
|
- Database migrations in `internal/db/schema/` — embedded via `go:embed`
|
||||||
- Each exported `Handle…` method of `Handlers` returns an `http.HandlerFunc`.
|
- SQLite by default (pure Go driver: modernc.org/sqlite)
|
||||||
- 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
|
## Testing
|
||||||
|
|
||||||
- Prefer table-driven tests.
|
- Table-driven tests preferred
|
||||||
- Use `testing.T` helpers, not assertion libraries.
|
- Use `testing.T` helpers, not assertion libraries
|
||||||
- A test file lives next to the code it tests and ends in `_test.go`.
|
- Test files live next to the code they test
|
||||||
- The linter requires each test file to be in the package's external test
|
- `_test.go` suffix, same package for white-box testing
|
||||||
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
|
## Dependencies
|
||||||
|
|
||||||
- The required libraries are listed in `CONVENTIONS.md` §1.
|
- Required libraries are listed in CONVENTIONS.md §1
|
||||||
- No new dependency without a reason given in the pull request.
|
- No new dependencies without justification
|
||||||
- Prefer dependencies written in pure Go, which build without cgo.
|
- Pure Go preferred (no CGO)
|
||||||
|
|||||||
+53
-61
@@ -108,7 +108,7 @@ func (a *App) handleInput(text string) {
|
|||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(
|
||||||
"[red]Send error: " + escape(err.Error()),
|
"[red]Send error: " + err.Error(),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -166,7 +166,7 @@ func (a *App) dispatchInfoCommand(cmd, args string) {
|
|||||||
a.cmdWhois(args)
|
a.cmdWhois(args)
|
||||||
default:
|
default:
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(
|
||||||
"[red]Unknown command: " + escape(cmd),
|
"[red]Unknown command: " + cmd,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -182,7 +182,7 @@ func (a *App) cmdConnect(serverURL string) {
|
|||||||
|
|
||||||
serverURL = strings.TrimRight(serverURL, "/")
|
serverURL = strings.TrimRight(serverURL, "/")
|
||||||
|
|
||||||
a.ui.AddStatus("Connecting to " + escape(serverURL) + "...")
|
a.ui.AddStatus("Connecting to " + serverURL + "...")
|
||||||
|
|
||||||
a.mu.Lock()
|
a.mu.Lock()
|
||||||
nick := a.nick
|
nick := a.nick
|
||||||
@@ -192,9 +192,9 @@ func (a *App) cmdConnect(serverURL string) {
|
|||||||
|
|
||||||
resp, err := client.CreateSession(nick)
|
resp, err := client.CreateSession(nick)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]Connection failed: " + escape(err.Error()),
|
"[red]Connection failed: %v", err,
|
||||||
)
|
))
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -218,7 +218,7 @@ func (a *App) cmdConnect(serverURL string) {
|
|||||||
|
|
||||||
a.ui.AddStatus(fmt.Sprintf(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[green]Connected! Nick: %s, Session: %d",
|
"[green]Connected! Nick: %s, Session: %d",
|
||||||
escape(resp.Nick), resp.ID,
|
resp.Nick, resp.ID,
|
||||||
))
|
))
|
||||||
a.ui.SetStatus(resp.Nick, "", "connected")
|
a.ui.SetStatus(resp.Nick, "", "connected")
|
||||||
|
|
||||||
@@ -244,7 +244,7 @@ func (a *App) cmdNick(nick string) {
|
|||||||
a.mu.Unlock()
|
a.mu.Unlock()
|
||||||
|
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(
|
||||||
"Nick set to " + escape(nick) +
|
"Nick set to " + nick +
|
||||||
" (will be used on connect)",
|
" (will be used on connect)",
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -256,9 +256,9 @@ func (a *App) cmdNick(nick string) {
|
|||||||
Body: []string{nick},
|
Body: []string{nick},
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]Nick change failed: " + escape(err.Error()),
|
"[red]Nick change failed: %v", err,
|
||||||
)
|
))
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -269,7 +269,7 @@ func (a *App) cmdNick(nick string) {
|
|||||||
a.mu.Unlock()
|
a.mu.Unlock()
|
||||||
|
|
||||||
a.ui.SetStatus(nick, target, "connected")
|
a.ui.SetStatus(nick, target, "connected")
|
||||||
a.ui.AddStatus("Nick changed to " + escape(nick))
|
a.ui.AddStatus("Nick changed to " + nick)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *App) cmdJoin(channel string) {
|
func (a *App) cmdJoin(channel string) {
|
||||||
@@ -297,9 +297,9 @@ func (a *App) cmdJoin(channel string) {
|
|||||||
|
|
||||||
err := a.client.JoinChannel(channel)
|
err := a.client.JoinChannel(channel)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]Join failed: " + escape(err.Error()),
|
"[red]Join failed: %v", err,
|
||||||
)
|
))
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -337,9 +337,9 @@ func (a *App) cmdPart(channel string) {
|
|||||||
|
|
||||||
err := a.client.PartChannel(channel)
|
err := a.client.PartChannel(channel)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]Part failed: " + escape(err.Error()),
|
"[red]Part failed: %v", err,
|
||||||
)
|
))
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -384,9 +384,9 @@ func (a *App) cmdMsg(args string) {
|
|||||||
Body: []string{text},
|
Body: []string{text},
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]Send failed: " + escape(err.Error()),
|
"[red]Send failed: %v", err,
|
||||||
)
|
))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -402,16 +402,10 @@ func (a *App) cmdQuery(nick string) {
|
|||||||
a.mu.Lock()
|
a.mu.Lock()
|
||||||
a.target = nick
|
a.target = nick
|
||||||
myNick := a.nick
|
myNick := a.nick
|
||||||
connected := a.connected
|
|
||||||
a.mu.Unlock()
|
a.mu.Unlock()
|
||||||
|
|
||||||
connStatus := "disconnected"
|
|
||||||
if connected {
|
|
||||||
connStatus = "connected"
|
|
||||||
}
|
|
||||||
|
|
||||||
a.ui.SwitchToBuffer(nick)
|
a.ui.SwitchToBuffer(nick)
|
||||||
a.ui.SetStatus(myNick, nick, connStatus)
|
a.ui.SetStatus(myNick, nick, "connected")
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *App) cmdTopic(args string) {
|
func (a *App) cmdTopic(args string) {
|
||||||
@@ -445,9 +439,9 @@ func (a *App) cmdTopic(args string) {
|
|||||||
Body: []string{args},
|
Body: []string{args},
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]Topic set failed: " + escape(err.Error()),
|
"[red]Topic set failed: %v", err,
|
||||||
)
|
))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -471,9 +465,9 @@ func (a *App) cmdNames() {
|
|||||||
|
|
||||||
members, err := a.client.GetMembers(target)
|
members, err := a.client.GetMembers(target)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]Names failed: " + escape(err.Error()),
|
"[red]Names failed: %v", err,
|
||||||
)
|
))
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -486,7 +480,7 @@ func (a *App) cmdNames() {
|
|||||||
|
|
||||||
a.ui.AddLine(target, fmt.Sprintf(
|
a.ui.AddLine(target, fmt.Sprintf(
|
||||||
"[cyan]*** Members of %s: %s",
|
"[cyan]*** Members of %s: %s",
|
||||||
escape(target), escape(strings.Join(nicks, " ")),
|
target, strings.Join(nicks, " "),
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -517,9 +511,9 @@ func (a *App) cmdList() {
|
|||||||
|
|
||||||
channels, err := a.client.ListChannels()
|
channels, err := a.client.ListChannels()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]List failed: " + escape(err.Error()),
|
"[red]List failed: %v", err,
|
||||||
)
|
))
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -528,7 +522,7 @@ func (a *App) cmdList() {
|
|||||||
|
|
||||||
for _, ch := range channels {
|
for _, ch := range channels {
|
||||||
a.ui.AddStatus(fmt.Sprintf(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
" %s %s", escape(ch.Name), escape(ch.Topic),
|
" %s %s", ch.Name, ch.Topic,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -550,9 +544,9 @@ func (a *App) cmdMotd() {
|
|||||||
&api.Message{Command: irc.CmdMotd}, //nolint:exhaustruct
|
&api.Message{Command: irc.CmdMotd}, //nolint:exhaustruct
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]MOTD failed: " + escape(err.Error()),
|
"[red]MOTD failed: %v", err,
|
||||||
)
|
))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -588,9 +582,9 @@ func (a *App) cmdWho(args string) {
|
|||||||
},
|
},
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]WHO failed: " + escape(err.Error()),
|
"[red]WHO failed: %v", err,
|
||||||
)
|
))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -619,9 +613,9 @@ func (a *App) cmdWhois(args string) {
|
|||||||
},
|
},
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.ui.AddStatus(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]WHOIS failed: " + escape(err.Error()),
|
"[red]WHOIS failed: %v", err,
|
||||||
)
|
))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -824,7 +818,7 @@ func (a *App) handlePrivmsgEvent(
|
|||||||
|
|
||||||
a.ui.AddLine(target, fmt.Sprintf(
|
a.ui.AddLine(target, fmt.Sprintf(
|
||||||
"[gray]%s [green]<%s>[white] %s",
|
"[gray]%s [green]<%s>[white] %s",
|
||||||
timestamp, escape(msg.From), escape(text),
|
timestamp, msg.From, text,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -837,7 +831,7 @@ func (a *App) handleJoinEvent(
|
|||||||
|
|
||||||
a.ui.AddLine(msg.To, fmt.Sprintf(
|
a.ui.AddLine(msg.To, fmt.Sprintf(
|
||||||
"[gray]%s [yellow]*** %s has joined %s",
|
"[gray]%s [yellow]*** %s has joined %s",
|
||||||
timestamp, escape(msg.From), escape(msg.To),
|
timestamp, msg.From, msg.To,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -856,11 +850,11 @@ func (a *App) handlePartEvent(
|
|||||||
|
|
||||||
line := fmt.Sprintf(
|
line := fmt.Sprintf(
|
||||||
"[gray]%s [yellow]*** %s has left %s",
|
"[gray]%s [yellow]*** %s has left %s",
|
||||||
timestamp, escape(msg.From), escape(msg.To),
|
timestamp, msg.From, msg.To,
|
||||||
)
|
)
|
||||||
|
|
||||||
if reason != "" {
|
if reason != "" {
|
||||||
line += " (" + escape(reason) + ")"
|
line += " (" + reason + ")"
|
||||||
}
|
}
|
||||||
|
|
||||||
if msg.From == myNick {
|
if msg.From == myNick {
|
||||||
@@ -881,12 +875,12 @@ func (a *App) handleQuitEvent(
|
|||||||
if reason != "" {
|
if reason != "" {
|
||||||
a.ui.AddStatus(fmt.Sprintf(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[gray]%s [yellow]*** %s has quit (%s)",
|
"[gray]%s [yellow]*** %s has quit (%s)",
|
||||||
timestamp, escape(msg.From), escape(reason),
|
timestamp, msg.From, reason,
|
||||||
))
|
))
|
||||||
} else {
|
} else {
|
||||||
a.ui.AddStatus(fmt.Sprintf(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[gray]%s [yellow]*** %s has quit",
|
"[gray]%s [yellow]*** %s has quit",
|
||||||
timestamp, escape(msg.From),
|
timestamp, msg.From,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -913,7 +907,7 @@ func (a *App) handleNickEvent(
|
|||||||
|
|
||||||
a.ui.AddStatus(fmt.Sprintf(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[gray]%s [yellow]*** %s is now known as %s",
|
"[gray]%s [yellow]*** %s is now known as %s",
|
||||||
timestamp, escape(msg.From), escape(newNick),
|
timestamp, msg.From, newNick,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -925,7 +919,7 @@ func (a *App) handleNoticeEvent(
|
|||||||
|
|
||||||
a.ui.AddStatus(fmt.Sprintf(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[gray]%s [magenta]--%s-- %s",
|
"[gray]%s [magenta]--%s-- %s",
|
||||||
timestamp, escape(msg.From), escape(text),
|
timestamp, msg.From, text,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -941,7 +935,7 @@ func (a *App) handleTopicEvent(
|
|||||||
|
|
||||||
a.ui.AddLine(msg.To, fmt.Sprintf(
|
a.ui.AddLine(msg.To, fmt.Sprintf(
|
||||||
"[gray]%s [cyan]*** %s set topic: %s",
|
"[gray]%s [cyan]*** %s set topic: %s",
|
||||||
timestamp, escape(msg.From), escape(text),
|
timestamp, msg.From, text,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -951,12 +945,10 @@ func (a *App) handleDefaultEvent(
|
|||||||
lines := msg.BodyLines()
|
lines := msg.BodyLines()
|
||||||
text := strings.Join(lines, " ")
|
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 != "" {
|
if text != "" {
|
||||||
a.ui.AddStatus(fmt.Sprintf(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[gray]%s [white]%s %s",
|
"[gray]%s [white][%s] %s",
|
||||||
timestamp, escape("["+msg.Command+"]"), escape(text),
|
timestamp, msg.Command, text,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
"unicode/utf8"
|
|
||||||
|
|
||||||
"github.com/gdamore/tcell/v2"
|
"github.com/gdamore/tcell/v2"
|
||||||
api "sneak.berlin/go/neoirc/internal/cli/api"
|
api "sneak.berlin/go/neoirc/internal/cli/api"
|
||||||
@@ -24,16 +23,9 @@ const (
|
|||||||
testText = "hello"
|
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
|
// 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
|
// be handled, for the welcome lines, or for the UI to stop, before
|
||||||
// or for a poll loop to end, before it fails.
|
// it fails.
|
||||||
const eventLoopTimeout = 5 * time.Second
|
const eventLoopTimeout = 5 * time.Second
|
||||||
|
|
||||||
// holdTime is how long a test waits to see that something does not
|
// holdTime is how long a test waits to see that something does not
|
||||||
@@ -369,46 +361,6 @@ 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
|
// TestEventLoopKeepsRunning sends Alt and 1, then a typed line and
|
||||||
// Enter, to a running UI. It checks that both are handled, so the
|
// Enter, to a running UI. It checks that both are handled, so the
|
||||||
// event loop did not stop on either.
|
// event loop did not stop on either.
|
||||||
@@ -800,31 +752,6 @@ 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,
|
// TestOwnEventFromOtherClient checks that a message, notice,
|
||||||
// join or part that the user's session makes from another
|
// join or part that the user's session makes from another
|
||||||
// client shows as one line in the buffer it belongs to.
|
// client shows as one line in the buffer it belongs to.
|
||||||
@@ -893,260 +820,6 @@ 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
|
// bufferState returns the number of lines in the named
|
||||||
// buffer and how many of them are unread.
|
// buffer and how many of them are unread.
|
||||||
func bufferState(ui *UI, name string) (int, int) {
|
func bufferState(ui *UI, name string) (int, int) {
|
||||||
@@ -1174,41 +847,6 @@ func statusBarText(ui *UI) string {
|
|||||||
return text
|
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
|
// handledLines makes app.ui pass each typed line to
|
||||||
// app.handleInput, as Run does, and returns a channel that
|
// app.handleInput, as Run does, and returns a channel that
|
||||||
// receives each line once it has been handled.
|
// receives each line once it has been handled.
|
||||||
@@ -1254,23 +892,6 @@ func newServer(t *testing.T, body string) *httptest.Server {
|
|||||||
return 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
|
// newHoldingServer starts a server that sends on the returned
|
||||||
// channel for each poll and holds the poll until its connection
|
// channel for each poll and holds the poll until its connection
|
||||||
// closes. It answers any other request with body.
|
// closes. It answers any other request with body.
|
||||||
@@ -1318,15 +939,11 @@ func waitPoll(t *testing.T, polled <-chan struct{}, server string) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// runUI runs ui on a simulated screen until the test ends, and
|
// runUI runs ui on a simulated screen until the test ends.
|
||||||
// returns the screen.
|
func runUI(t *testing.T, ui *UI) {
|
||||||
//
|
|
||||||
//nolint:ireturn // tcell has no exported type for the screen
|
|
||||||
func runUI(t *testing.T, ui *UI) tcell.SimulationScreen {
|
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
screen := tcell.NewSimulationScreen("")
|
ui.app.SetScreen(tcell.NewSimulationScreen(""))
|
||||||
ui.app.SetScreen(screen)
|
|
||||||
|
|
||||||
// One slot, so that Run's goroutine can end even after the
|
// One slot, so that Run's goroutine can end even after the
|
||||||
// cleanup below has stopped waiting for it.
|
// cleanup below has stopped waiting for it.
|
||||||
@@ -1346,6 +963,4 @@ func runUI(t *testing.T, ui *UI) tcell.SimulationScreen {
|
|||||||
t.Error("the UI did not stop: its event loop stopped responding")
|
t.Error("the UI did not stop: its event loop stopped responding")
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
return screen
|
|
||||||
}
|
}
|
||||||
|
|||||||
+2
-24
@@ -30,12 +30,6 @@ type UI struct {
|
|||||||
buffers []*Buffer
|
buffers []*Buffer
|
||||||
currentBuffer int
|
currentBuffer int
|
||||||
|
|
||||||
// The nick, target and connection state last passed to
|
|
||||||
// SetStatus.
|
|
||||||
nick string
|
|
||||||
target string
|
|
||||||
connStatus string
|
|
||||||
|
|
||||||
onInput func(string)
|
onInput func(string)
|
||||||
// inputDone is closed once the line last passed to onInput
|
// inputDone is closed once the line last passed to onInput
|
||||||
// has been handled. Only callOnInput, on the event loop, uses
|
// has been handled. Only callOnInput, on the event loop, uses
|
||||||
@@ -185,11 +179,7 @@ func (ui *UI) SetStatus(
|
|||||||
nick, target, connStatus string,
|
nick, target, connStatus string,
|
||||||
) {
|
) {
|
||||||
ui.app.QueueUpdateDraw(func() {
|
ui.app.QueueUpdateDraw(func() {
|
||||||
ui.nick = nick
|
ui.renderStatusBar(nick, target, connStatus)
|
||||||
ui.target = target
|
|
||||||
ui.connStatus = connStatus
|
|
||||||
|
|
||||||
ui.refreshStatusBar()
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -235,16 +225,6 @@ func (ui *UI) initMessages() {
|
|||||||
ui.messages.SetBorder(false)
|
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() {
|
func (ui *UI) initStatusBar() {
|
||||||
// Colour tags stay off. With them on, tview reads text in
|
// Colour tags stay off. With them on, tview reads text in
|
||||||
// square brackets, such as "[connected]" or part of a nick,
|
// square brackets, such as "[connected]" or part of a nick,
|
||||||
@@ -320,10 +300,8 @@ 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() {
|
func (ui *UI) refreshStatusBar() {
|
||||||
ui.renderStatusBar(ui.nick, ui.target, ui.connStatus)
|
// Placeholder; full refresh needs nick/target context.
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ui *UI) renderStatusBar(
|
func (ui *UI) renderStatusBar(
|
||||||
|
|||||||
@@ -188,7 +188,7 @@ func (hdlr *Handlers) handleCreateSession(
|
|||||||
|
|
||||||
var payload createRequest
|
var payload createRequest
|
||||||
|
|
||||||
err := decodeJSON(request, &payload)
|
err := json.NewDecoder(request.Body).Decode(&payload)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
hdlr.respondError(
|
hdlr.respondError(
|
||||||
writer, request,
|
writer, request,
|
||||||
@@ -412,7 +412,7 @@ func (hdlr *Handlers) deliverWelcome(
|
|||||||
// 004 RPL_MYINFO
|
// 004 RPL_MYINFO
|
||||||
hdlr.enqueueNumeric(
|
hdlr.enqueueNumeric(
|
||||||
ctx, clientID, irc.RplMyInfo, nick,
|
ctx, clientID, irc.RplMyInfo, nick,
|
||||||
[]string{srvName, version, service.UserModes, "Hbiklmnostv"},
|
[]string{srvName, version, service.UserModes, "ikmnostl"},
|
||||||
"",
|
"",
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -925,7 +925,7 @@ func (hdlr *Handlers) HandleSendCommand() http.HandlerFunc {
|
|||||||
|
|
||||||
var payload commandRequest
|
var payload commandRequest
|
||||||
|
|
||||||
err := decodeJSON(request, &payload)
|
err := json.NewDecoder(request.Body).Decode(&payload)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
hdlr.respondError(
|
hdlr.respondError(
|
||||||
writer, request,
|
writer, request,
|
||||||
@@ -994,7 +994,7 @@ func (hdlr *Handlers) dispatchCommand(
|
|||||||
hdlr.handlePrivmsg(
|
hdlr.handlePrivmsg(
|
||||||
writer, request,
|
writer, request,
|
||||||
sessionID, clientID, nick,
|
sessionID, clientID, nick,
|
||||||
command, target, body, meta,
|
command, target, body, meta, bodyLines,
|
||||||
)
|
)
|
||||||
case irc.CmdJoin:
|
case irc.CmdJoin:
|
||||||
hdlr.handleJoin(
|
hdlr.handleJoin(
|
||||||
@@ -1139,18 +1139,8 @@ func (hdlr *Handlers) handlePrivmsg(
|
|||||||
nick, command, target string,
|
nick, command, target string,
|
||||||
body json.RawMessage,
|
body json.RawMessage,
|
||||||
meta 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 == "" {
|
if target == "" {
|
||||||
hdlr.enqueueNumeric(
|
hdlr.enqueueNumeric(
|
||||||
request.Context(), clientID,
|
request.Context(), clientID,
|
||||||
@@ -1165,6 +1155,7 @@ func (hdlr *Handlers) handlePrivmsg(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
lines := bodyLines()
|
||||||
if len(lines) == 0 {
|
if len(lines) == 0 {
|
||||||
hdlr.enqueueNumeric(
|
hdlr.enqueueNumeric(
|
||||||
request.Context(), clientID,
|
request.Context(), clientID,
|
||||||
@@ -1198,44 +1189,6 @@ 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
|
// respondIRCError enqueues a numeric error reply, notifies
|
||||||
// the broker, and sends HTTP 200 with {"status":"error"}.
|
// the broker, and sends HTTP 200 with {"status":"error"}.
|
||||||
func (hdlr *Handlers) respondIRCError(
|
func (hdlr *Handlers) respondIRCError(
|
||||||
@@ -3238,7 +3191,7 @@ func (hdlr *Handlers) handleWho(
|
|||||||
// 315 RPL_ENDOFWHO (empty result)
|
// 315 RPL_ENDOFWHO (empty result)
|
||||||
hdlr.enqueueNumeric(
|
hdlr.enqueueNumeric(
|
||||||
ctx, clientID, irc.RplEndOfWho, nick,
|
ctx, clientID, irc.RplEndOfWho, nick,
|
||||||
[]string{channel},
|
[]string{target},
|
||||||
"End of /WHO list",
|
"End of /WHO list",
|
||||||
)
|
)
|
||||||
hdlr.broker.Notify(sessionID)
|
hdlr.broker.Notify(sessionID)
|
||||||
|
|||||||
+17
-280
@@ -8,12 +8,10 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"maps"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"net/url"
|
"net/url"
|
||||||
"os"
|
"os"
|
||||||
"reflect"
|
|
||||||
"slices"
|
"slices"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -797,107 +795,6 @@ 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.sendCommand(token, map[string]any{
|
|
||||||
commandKey: irc.CmdPass,
|
|
||||||
bodyKey: []string{testPassword},
|
|
||||||
})
|
|
||||||
|
|
||||||
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) {
|
func TestAuthNoCookie(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -1102,8 +999,6 @@ 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) {
|
func TestMessageMissingBody(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -1118,25 +1013,20 @@ func TestMessageMissingBody(t *testing.T) {
|
|||||||
|
|
||||||
_, lastID := tserver.pollMessages(token, 0)
|
_, lastID := tserver.pollMessages(token, 0)
|
||||||
|
|
||||||
for _, request := range []map[string]any{
|
status, _ := tserver.sendCommand(token, map[string]any{
|
||||||
{commandKey: privmsgCmd, toKey: channel},
|
commandKey: privmsgCmd, toKey: channel,
|
||||||
{commandKey: privmsgCmd, toKey: channel, bodyKey: []string{}},
|
})
|
||||||
} {
|
if status != http.StatusOK {
|
||||||
status, _ := tserver.sendCommand(token, request)
|
t.Fatalf("expected 200, got %d", status)
|
||||||
if status != http.StatusOK {
|
}
|
||||||
t.Fatalf("%v: expected 200, got %d", request, status)
|
|
||||||
}
|
|
||||||
|
|
||||||
var msgs []map[string]any
|
msgs, _ := tserver.pollMessages(token, lastID)
|
||||||
|
|
||||||
msgs, lastID = tserver.pollMessages(token, lastID)
|
if !findNumeric(msgs, "412") {
|
||||||
|
t.Fatalf(
|
||||||
if !findNumeric(msgs, "412") {
|
"expected ERR_NOTEXTTOSEND (412), got %v",
|
||||||
t.Fatalf(
|
msgs,
|
||||||
"%v: expected ERR_NOTEXTTOSEND (412), got %v",
|
)
|
||||||
request, msgs,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1166,132 +1056,6 @@ 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) {
|
func TestNonMemberCannotSend(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -4140,31 +3904,6 @@ 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) {
|
func TestSessionUsernameDefault(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -7058,10 +6797,9 @@ func TestISUPPORT(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestMyInfoListsModes verifies the 004 numeric lists the
|
// TestMyInfoListsUserModes verifies the 004 numeric lists
|
||||||
// user modes o and w as its third parameter, and the HTTP
|
// the user modes o and w as its third parameter.
|
||||||
// API's channel modes Hbiklmnostv as its fourth.
|
func TestMyInfoListsUserModes(t *testing.T) {
|
||||||
func TestMyInfoListsModes(t *testing.T) {
|
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
tserver := newTestServer(t)
|
tserver := newTestServer(t)
|
||||||
@@ -7075,10 +6813,9 @@ func TestMyInfoListsModes(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
params := getNumericParams(myInfo)
|
params := getNumericParams(myInfo)
|
||||||
if len(params) != 4 || params[2] != "ow" ||
|
if len(params) != 4 || params[2] != "ow" {
|
||||||
params[3] != "Hbiklmnostv" {
|
|
||||||
t.Fatalf(
|
t.Fatalf(
|
||||||
"004 params %v, want four ending ow Hbiklmnostv",
|
"004 params %v, want four with user modes ow third",
|
||||||
params,
|
params,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
package handlers
|
package handlers
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"encoding/json"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
@@ -54,7 +55,7 @@ func (hdlr *Handlers) handleLogin(
|
|||||||
|
|
||||||
var payload loginRequest
|
var payload loginRequest
|
||||||
|
|
||||||
err := decodeJSON(request, &payload)
|
err := json.NewDecoder(request.Body).Decode(&payload)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
hdlr.respondError(
|
hdlr.respondError(
|
||||||
writer, request,
|
writer, request,
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"io"
|
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
"time"
|
"time"
|
||||||
@@ -160,18 +159,6 @@ 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 {
|
func (hdlr *Handlers) idleTimeout() time.Duration {
|
||||||
raw := hdlr.params.Config.SessionIdleTimeout
|
raw := hdlr.params.Config.SessionIdleTimeout
|
||||||
if raw == "" {
|
if raw == "" {
|
||||||
|
|||||||
@@ -371,7 +371,6 @@ func (c *Conn) handleQuit(msg *Message) {
|
|||||||
|
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
c.closed = true
|
c.closed = true
|
||||||
c.quitReason = reason
|
|
||||||
c.mu.Unlock()
|
c.mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1227,12 +1226,9 @@ func (c *Conn) handlePassPostReg(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// The IRC listener cannot add a connection to an existing
|
|
||||||
// session; only the HTTP API login can.
|
|
||||||
c.sendFromServer("NOTICE", c.currentNick(),
|
c.sendFromServer("NOTICE", c.currentNick(),
|
||||||
"Password set. Another client can log in to this "+
|
"Password set. You can reconnect using "+
|
||||||
"session over the HTTP API: POST /api/v1/login "+
|
"PASS <password> with your nick.",
|
||||||
"with your nick and this password.",
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+12
-17
@@ -69,11 +69,6 @@ type Conn struct {
|
|||||||
lastQueueID int64
|
lastQueueID int64
|
||||||
closed bool
|
closed bool
|
||||||
killed bool
|
killed bool
|
||||||
|
|
||||||
// quitReason is the reason in the QUIT that peers are
|
|
||||||
// sent when the connection ends. The client's QUIT
|
|
||||||
// replaces it.
|
|
||||||
quitReason string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func newConn(
|
func newConn(
|
||||||
@@ -92,15 +87,14 @@ func newConn(
|
|||||||
}
|
}
|
||||||
|
|
||||||
conn := &Conn{ //nolint:exhaustruct // zero-value defaults
|
conn := &Conn{ //nolint:exhaustruct // zero-value defaults
|
||||||
conn: tcpConn,
|
conn: tcpConn,
|
||||||
log: log,
|
log: log,
|
||||||
database: database,
|
database: database,
|
||||||
brk: brk,
|
brk: brk,
|
||||||
cfg: cfg,
|
cfg: cfg,
|
||||||
svc: svc,
|
svc: svc,
|
||||||
serverSfx: srvName,
|
serverSfx: srvName,
|
||||||
remoteIP: host,
|
remoteIP: host,
|
||||||
quitReason: "Connection closed",
|
|
||||||
}
|
}
|
||||||
|
|
||||||
conn.commands = conn.buildCommandMap()
|
conn.commands = conn.buildCommandMap()
|
||||||
@@ -284,7 +278,6 @@ func (c *Conn) cleanup(ctx context.Context) {
|
|||||||
wasKilled := c.killed
|
wasKilled := c.killed
|
||||||
sessID := c.sessionID
|
sessID := c.sessionID
|
||||||
nick := c.nick
|
nick := c.nick
|
||||||
quitReason := c.quitReason
|
|
||||||
c.closed = true
|
c.closed = true
|
||||||
c.mu.Unlock()
|
c.mu.Unlock()
|
||||||
|
|
||||||
@@ -294,7 +287,9 @@ func (c *Conn) cleanup(ctx context.Context) {
|
|||||||
// KILL has already sent the QUIT and deleted the
|
// KILL has already sent the QUIT and deleted the
|
||||||
// session.
|
// session.
|
||||||
if !wasKilled {
|
if !wasKilled {
|
||||||
c.svc.BroadcastQuit(ctx, sessID, nick, quitReason)
|
c.svc.BroadcastQuit(
|
||||||
|
ctx, sessID, nick, "Connection closed",
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -610,7 +605,7 @@ func (c *Conn) deliverWelcome() {
|
|||||||
)
|
)
|
||||||
c.sendNumeric(
|
c.sendNumeric(
|
||||||
irc.RplMyInfo,
|
irc.RplMyInfo,
|
||||||
c.serverSfx, "neoirc", service.UserModes, "Himnostv",
|
c.serverSfx, "neoirc", service.UserModes, "mnst",
|
||||||
)
|
)
|
||||||
c.sendNumeric(
|
c.sendNumeric(
|
||||||
irc.RplIsupport,
|
irc.RplIsupport,
|
||||||
|
|||||||
@@ -316,7 +316,7 @@ func TestRelayNickDiffersOnlyInCase(t *testing.T) {
|
|||||||
{"JOIN #case", ":Alice!Alice@* JOIN #case"},
|
{"JOIN #case", ":Alice!Alice@* JOIN #case"},
|
||||||
{"NICK Alicia", ":Alice!Alice@* NICK Alicia"},
|
{"NICK Alicia", ":Alice!Alice@* NICK Alicia"},
|
||||||
{"NICK Alice", ":Alicia!Alicia@* NICK Alice"}, // back for QUIT
|
{"NICK Alice", ":Alicia!Alicia@* NICK Alice"}, // back for QUIT
|
||||||
{"QUIT", ":Alice!Alice@* QUIT :Quit: Client quit"},
|
{"QUIT", ":Alice!Alice@* QUIT :Quit: Connection closed"},
|
||||||
} {
|
} {
|
||||||
capitalAlice.send(step.line)
|
capitalAlice.send(step.line)
|
||||||
|
|
||||||
|
|||||||
@@ -4,14 +4,12 @@ import (
|
|||||||
"bufio"
|
"bufio"
|
||||||
"context"
|
"context"
|
||||||
"database/sql"
|
"database/sql"
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net"
|
"net"
|
||||||
"os"
|
"os"
|
||||||
"runtime"
|
"runtime"
|
||||||
"slices"
|
|
||||||
"strings"
|
"strings"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"testing"
|
"testing"
|
||||||
@@ -25,7 +23,6 @@ import (
|
|||||||
"sneak.berlin/go/neoirc/internal/globals"
|
"sneak.berlin/go/neoirc/internal/globals"
|
||||||
"sneak.berlin/go/neoirc/internal/ircserver"
|
"sneak.berlin/go/neoirc/internal/ircserver"
|
||||||
"sneak.berlin/go/neoirc/internal/logger"
|
"sneak.berlin/go/neoirc/internal/logger"
|
||||||
"sneak.berlin/go/neoirc/pkg/irc"
|
|
||||||
|
|
||||||
_ "modernc.org/sqlite"
|
_ "modernc.org/sqlite"
|
||||||
)
|
)
|
||||||
@@ -489,20 +486,20 @@ func TestWelcomeContainsNick(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestMyInfoListsModes checks that RPL_MYINFO lists the user
|
// TestMyInfoListsUserModes checks that RPL_MYINFO lists the
|
||||||
// modes o and w, then the channel modes MODE accepts on the
|
// user modes o and w, with no empty parameter before the
|
||||||
// IRC listener. It compares the whole line, so a missing or
|
// channel modes.
|
||||||
// extra mode fails it.
|
func TestMyInfoListsUserModes(t *testing.T) {
|
||||||
func TestMyInfoListsModes(t *testing.T) {
|
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
env := newTestEnv(t)
|
env := newTestEnv(t)
|
||||||
lines := env.dial(t).register("carol")
|
lines := env.dial(t).register("carol")
|
||||||
|
|
||||||
want := ":test.irc 004 carol test.irc neoirc ow Himnostv"
|
assertContains(
|
||||||
if !slices.Contains(lines, want) {
|
t, lines,
|
||||||
t.Errorf("no line %q in %v", want, lines)
|
":test.irc 004 carol test.irc neoirc ow mnst",
|
||||||
}
|
"RPL_MYINFO with user modes",
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPingPong(t *testing.T) {
|
func TestPingPong(t *testing.T) {
|
||||||
@@ -875,112 +872,6 @@ func TestQuit(t *testing.T) {
|
|||||||
assertContains(t, lines, "goodbye", "QUIT reason")
|
assertContains(t, lines, "goodbye", "QUIT reason")
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestQuitReasonReachesPeers checks the reason that an IRC
|
|
||||||
// listener user's channel peers see in its QUIT, on both the
|
|
||||||
// IRC listener and the HTTP API. It is the reason the user
|
|
||||||
// gave, Client quit for a QUIT without one, or Connection
|
|
||||||
// closed when the connection ends without a QUIT.
|
|
||||||
func TestQuitReasonReachesPeers(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
for _, step := range []struct {
|
|
||||||
name, quit, want string
|
|
||||||
}{
|
|
||||||
{"QUIT with a reason", "QUIT :gone home", "gone home"},
|
|
||||||
{"QUIT without a reason", irc.CmdQuit, "Client quit"},
|
|
||||||
{"connection closed without QUIT", "", "Connection closed"},
|
|
||||||
} {
|
|
||||||
t.Run(step.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ircLine, apiBody := quitSeenByPeers(t, step.quit)
|
|
||||||
|
|
||||||
want := ":quitter!quitter@* QUIT :Quit: " + step.want
|
|
||||||
if ircLine != want {
|
|
||||||
t.Errorf("IRC peer got %q, want %q", ircLine, want)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(apiBody) != 1 || apiBody[0] != step.want {
|
|
||||||
t.Errorf("HTTP API peer got %q, want [%q]", apiBody, step.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// quitSeenByPeers starts a server on which quitter, ircpeer on
|
|
||||||
// the IRC listener and apipeer on the HTTP API share a channel.
|
|
||||||
// quitter sends the line quit, or closes its connection when
|
|
||||||
// quit is empty. It returns the QUIT line ircpeer is sent and
|
|
||||||
// the body of the QUIT apipeer is sent.
|
|
||||||
func quitSeenByPeers(t *testing.T, quit string) (string, []string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
env := newTestEnv(t)
|
|
||||||
ctx := t.Context()
|
|
||||||
|
|
||||||
ircPeer := env.dial(t)
|
|
||||||
ircPeer.register("ircpeer")
|
|
||||||
ircPeer.joinAndDrain("#bye")
|
|
||||||
|
|
||||||
apiPeerID, apiPeerClientID, _, err := env.database.CreateSession(
|
|
||||||
ctx, "apipeer", "apipeer", "", "",
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
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)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("join peer: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
quitter := env.dial(t)
|
|
||||||
quitter.register("quitter")
|
|
||||||
quitter.joinAndDrain("#bye")
|
|
||||||
|
|
||||||
if quit == "" {
|
|
||||||
err = quitter.conn.Close()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("close: %v", err)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
quitter.send(quit)
|
|
||||||
}
|
|
||||||
|
|
||||||
lines := ircPeer.readUntil(func(l string) bool {
|
|
||||||
return strings.Contains(l, " QUIT ")
|
|
||||||
})
|
|
||||||
|
|
||||||
// The QUIT is queued to both peers at once, so apipeer has
|
|
||||||
// it by now.
|
|
||||||
msgs, _, err := env.database.PollMessages(ctx, apiPeerClientID, 0, 0)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("poll peer: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, msg := range msgs {
|
|
||||||
if msg.Command == irc.CmdQuit && msg.From == "quitter" {
|
|
||||||
var body []string
|
|
||||||
|
|
||||||
err = json.Unmarshal(msg.Body, &body)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("decode QUIT body %s: %v", msg.Body, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return lines[len(lines)-1], body
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Fatalf("apipeer was not sent the QUIT: %v", msgs)
|
|
||||||
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestStopEndsSessions checks that stopping the server ends
|
// TestStopEndsSessions checks that stopping the server ends
|
||||||
// a registered connection's session before Stop returns, as
|
// a registered connection's session before Stop returns, as
|
||||||
// closing the connection does: the session, its client and
|
// closing the connection does: the session, its client and
|
||||||
@@ -1250,9 +1141,6 @@ func TestAwaySetAndClear(t *testing.T) {
|
|||||||
assertContains(t, clearLines, " 305 ", "RPL_UNAWAY")
|
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) {
|
func TestHandlePassPostRegistration(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -1265,11 +1153,7 @@ func TestHandlePassPostRegistration(t *testing.T) {
|
|||||||
)
|
)
|
||||||
|
|
||||||
assertContains(
|
assertContains(
|
||||||
t, lines,
|
t, lines, "Password set", "password confirmation",
|
||||||
" 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",
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+82
-17
@@ -20,7 +20,7 @@ are the fields it can have:
|
|||||||
- `code`: the number of a numeric reply, such as `1` for `RPL_WELCOME`. Absent
|
- `code`: the number of a numeric reply, such as `1` for `RPL_WELCOME`. Absent
|
||||||
on other messages.
|
on other messages.
|
||||||
- `id`: the message's UUID, a unique ID that the server assigns.
|
- `id`: the message's UUID, a unique ID that the server assigns.
|
||||||
- `from`: the sender's nick, or the server name on a numeric reply or a `PONG`.
|
- `from`: the sender's nick, or the server name on a server message.
|
||||||
- `to`: the target, such as a channel name starting with `#` or a nick.
|
- `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.
|
- `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`
|
`KICK` events and many numeric replies have it. The HTTP API ignores `params`
|
||||||
@@ -60,32 +60,29 @@ A `PRIVMSG` whose `body` has two strings is a two-line message:
|
|||||||
|
|
||||||
## Files
|
## 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/`:
|
Commands, in `commands/`:
|
||||||
|
|
||||||
- `PRIVMSG.json`: a message to a channel or a user.
|
- `PRIVMSG.json`: a message to a channel or a user.
|
||||||
- `NOTICE.json`: a notice, which is a message that a client must not answer
|
- `NOTICE.json`: a notice, which is a message that a client must not answer
|
||||||
automatically.
|
automatically.
|
||||||
- `JOIN.json`: joining a channel.
|
- `JOIN.json`: a user joined a channel.
|
||||||
- `PART.json`: leaving a channel.
|
- `PART.json`: a user left a channel.
|
||||||
- `QUIT.json`: leaving the server.
|
- `QUIT.json`: a user left the server.
|
||||||
- `NICK.json`: changing nick.
|
- `NICK.json`: a user changed nick.
|
||||||
- `TOPIC.json`: setting a channel's topic.
|
- `TOPIC.json`: a channel topic was set.
|
||||||
- `MODE.json`: querying or changing a channel's modes or the user's own modes.
|
- `MODE.json`: a channel mode was changed.
|
||||||
- `KICK.json`: a channel operator removing a user from a channel.
|
- `KICK.json`: a channel operator removed a user from a channel.
|
||||||
- `PING.json`: a check that the server still answers.
|
- `PING.json`: a check that the server still answers.
|
||||||
- `PONG.json`: the answer to a `PING`, which is the HTTP response to it.
|
- `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`).
|
||||||
|
|
||||||
Numeric replies, in `numerics/`:
|
Numeric replies, in `numerics/`:
|
||||||
|
|
||||||
- `001.json`: `RPL_WELCOME`, which welcomes the user.
|
- `001.json`: `RPL_WELCOME`, which welcomes a new user.
|
||||||
- `002.json`: `RPL_YOURHOST`, the server's name and version.
|
- `002.json`: `RPL_YOURHOST`, the server's name and version.
|
||||||
- `003.json`: `RPL_CREATED`, the date the server last started.
|
- `003.json`: `RPL_CREATED`, which says when the server was created.
|
||||||
- `004.json`: `RPL_MYINFO`, the server's name, its version and its lists of
|
- `004.json`: `RPL_MYINFO`, the server's version and its lists of modes.
|
||||||
modes.
|
|
||||||
- `322.json`: `RPL_LIST`, one channel in the answer to `LIST`.
|
- `322.json`: `RPL_LIST`, one channel in the answer to `LIST`.
|
||||||
- `323.json`: `RPL_LISTEND`, the end of the answer to `LIST`.
|
- `323.json`: `RPL_LISTEND`, the end of the answer to `LIST`.
|
||||||
- `332.json`: `RPL_TOPIC`, a channel's topic.
|
- `332.json`: `RPL_TOPIC`, a channel's topic.
|
||||||
@@ -99,3 +96,71 @@ Numeric replies, in `numerics/`:
|
|||||||
- `433.json`: `ERR_NICKNAMEINUSE`, the nick is taken.
|
- `433.json`: `ERR_NICKNAMEINUSE`, the nick is taken.
|
||||||
- `442.json`: `ERR_NOTONCHANNEL`, the user is not on that channel.
|
- `442.json`: `ERR_NOTONCHANNEL`, the user is not on that channel.
|
||||||
- `482.json`: `ERR_CHANOPRIVSNEEDED`, the user is not a channel operator.
|
- `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 `ikmnostl` 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,25 +2,15 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/JOIN.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/JOIN.json",
|
||||||
"title": "JOIN",
|
"title": "JOIN",
|
||||||
"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.",
|
"description": "Join a channel. C2S: request to join. S2C: notification that a user joined. RFC 1459 §4.2.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "JOIN" },
|
"command": { "const": "JOIN" },
|
||||||
"from": { "type": "string", "description": "The nick that joined. The server sets it." },
|
"from": { "type": "string", "description": "Nick that joined (S2C)." },
|
||||||
"to": {
|
"to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" }
|
||||||
"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"],
|
"required": ["command", "to"],
|
||||||
"examples": [
|
"examples": [
|
||||||
{ "command": "JOIN", "to": "#general" },
|
{ "command": "JOIN", "from": "alice", "to": "#general" }
|
||||||
{ "command": "JOIN", "from": "alice", "to": "#general", "body": ["#general"] }
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,33 +2,28 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/KICK.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/KICK.json",
|
||||||
"title": "KICK",
|
"title": "KICK",
|
||||||
"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.",
|
"description": "Kick a user from a channel. RFC 1459 §4.2.8.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "KICK" },
|
"command": { "const": "KICK" },
|
||||||
"from": { "type": "string", "description": "The nick that removed the user. The server sets it." },
|
"from": { "type": "string", "description": "Nick that performed the kick." },
|
||||||
"to": {
|
"to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" },
|
||||||
"type": "string",
|
|
||||||
"description": "The channel name. The server adds the # if a client leaves it out.",
|
|
||||||
"pattern": "^#?[a-zA-Z0-9_-]{1,63}$"
|
|
||||||
},
|
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": { "type": "string" },
|
"items": { "type": "string" },
|
||||||
"description": "The removed nick. Only the server sends it.",
|
"description": "Kicked nick. e.g. [\"alice\"].",
|
||||||
"minItems": 1,
|
"minItems": 1,
|
||||||
"maxItems": 1
|
"maxItems": 1
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": { "type": "string" },
|
"items": { "type": "string" },
|
||||||
"description": "From a client: the nick to remove, then an optional reason. From the server: the reason, as one string.",
|
"description": "Optional kick reason.",
|
||||||
"minItems": 1
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": ["command", "to", "body"],
|
"required": ["command", "to", "params"],
|
||||||
"examples": [
|
"examples": [
|
||||||
{ "command": "KICK", "to": "#general", "body": ["troll", "Behave"] },
|
|
||||||
{ "command": "KICK", "from": "op1", "to": "#general", "params": ["troll"], "body": ["Behave"] }
|
{ "command": "KICK", "from": "op1", "to": "#general", "params": ["troll"], "body": ["Behave"] }
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,29 +2,28 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/MODE.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/MODE.json",
|
||||||
"title": "MODE",
|
"title": "MODE",
|
||||||
"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.",
|
"description": "Set or query channel/user modes. RFC 1459 §4.2.3.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "MODE" },
|
"command": { "const": "MODE" },
|
||||||
"from": {
|
"from": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The nick that changed the mode. The server sets it."
|
"description": "Nick that set the mode (S2C only)."
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "A channel name, which starts with #, or the user's own nick."
|
"description": "Channel name.",
|
||||||
|
"pattern": "^#[a-zA-Z0-9_-]+$"
|
||||||
},
|
},
|
||||||
"body": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": { "type": "string" },
|
"items": { "type": "string" },
|
||||||
"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\".",
|
"description": "Mode string and optional target nick. e.g. [\"+o\", \"alice\"].",
|
||||||
"examples": [["+o", "bob"], ["-m"], ["+o bob"], ["+k", "secret"]]
|
"examples": [["+o", "alice"], ["-m"], ["+v", "bob"]]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": ["command", "to"],
|
"required": ["command", "to", "params"],
|
||||||
"examples": [
|
"examples": [
|
||||||
{ "command": "MODE", "to": "#general", "body": ["+o", "bob"] },
|
{ "command": "MODE", "from": "op1", "to": "#general", "params": ["+o", "alice"] }
|
||||||
{ "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",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/NICK.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/NICK.json",
|
||||||
"title": "NICK",
|
"title": "NICK",
|
||||||
"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.",
|
"description": "Change nickname. C2S: request new nick. S2C: notification of nick change. RFC 1459 §4.1.2.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "NICK" },
|
"command": { "const": "NICK" },
|
||||||
"from": { "type": "string", "description": "The old nick. The server sets it." },
|
"from": { "type": "string", "description": "Old nick (S2C)." },
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": { "type": "string" },
|
"items": { "type": "string" },
|
||||||
"description": "The new nick, as the first string. The server sends one string.",
|
"description": "New nick (single-element array).",
|
||||||
"minItems": 1
|
"minItems": 1,
|
||||||
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": ["command", "body"],
|
"required": ["command", "body"],
|
||||||
"examples": [
|
"examples": [
|
||||||
{ "command": "NICK", "body": ["newnick"] },
|
|
||||||
{ "command": "NICK", "from": "oldnick", "body": ["newnick"] }
|
{ "command": "NICK", "from": "oldnick", "body": ["newnick"] }
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,21 +2,20 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/NOTICE.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/NOTICE.json",
|
||||||
"title": "NOTICE",
|
"title": "NOTICE",
|
||||||
"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.",
|
"description": "Send a notice. Like PRIVMSG but must not trigger automatic replies. RFC 1459 §4.4.2.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "NOTICE" },
|
"command": { "const": "NOTICE" },
|
||||||
"from": { "type": "string", "description": "The sender's nick. The server sets it." },
|
"from": { "type": "string" },
|
||||||
"to": { "type": "string", "description": "A channel name, which starts with #, or a nick." },
|
"to": { "type": "string", "description": "Target: #channel, nick, or * (global)." },
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": { "type": "string" },
|
"items": { "type": "string" },
|
||||||
"description": "The lines of the notice, one string per line.",
|
"description": "Notice text lines."
|
||||||
"minItems": 1
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": ["command", "to", "body"],
|
"required": ["command", "to", "body"],
|
||||||
"examples": [
|
"examples": [
|
||||||
{ "command": "NOTICE", "from": "alice", "to": "#general", "body": ["Back in five minutes"] }
|
{ "command": "NOTICE", "from": "server.example.com", "to": "*", "body": ["Server restarting in 5 minutes"] }
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,20 +2,17 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PART.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PART.json",
|
||||||
"title": "PART",
|
"title": "PART",
|
||||||
"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.",
|
"description": "Leave a channel. C2S: request to leave. S2C: notification that a user left. RFC 1459 §4.2.2.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "PART" },
|
"command": { "const": "PART" },
|
||||||
"from": { "type": "string", "description": "The nick that left. The server sets it." },
|
"from": { "type": "string", "description": "Nick that left (S2C)." },
|
||||||
"to": {
|
"to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" },
|
||||||
"type": "string",
|
|
||||||
"description": "The channel name. The server adds the # if a client leaves it out.",
|
|
||||||
"pattern": "^#?[a-zA-Z0-9_-]{1,63}$"
|
|
||||||
},
|
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": { "type": "string" },
|
"items": { "type": "string" },
|
||||||
"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."
|
"description": "Optional part reason.",
|
||||||
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": ["command", "to"],
|
"required": ["command", "to"],
|
||||||
|
|||||||
@@ -2,13 +2,19 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PING.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PING.json",
|
||||||
"title": "PING",
|
"title": "PING",
|
||||||
"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.",
|
"description": "Keepalive. C2S or S2S. Server responds with PONG. RFC 1459 §4.6.2.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "PING" }
|
"command": { "const": "PING" },
|
||||||
|
"body": {
|
||||||
|
"type": "array",
|
||||||
|
"items": { "type": "string" },
|
||||||
|
"description": "Opaque token to be echoed in PONG (single-element array).",
|
||||||
|
"maxItems": 1
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"required": ["command"],
|
"required": ["command"],
|
||||||
"examples": [
|
"examples": [
|
||||||
{ "command": "PING" }
|
{ "command": "PING", "body": ["1707580000"] }
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,14 +2,20 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PONG.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PONG.json",
|
||||||
"title": "PONG",
|
"title": "PONG",
|
||||||
"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.",
|
"description": "Keepalive response. S2C or S2S. RFC 1459 §4.6.3.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "PONG" },
|
"command": { "const": "PONG" },
|
||||||
"from": { "type": "string", "description": "The server name." }
|
"from": { "type": "string", "description": "Responding server name." },
|
||||||
|
"body": {
|
||||||
|
"type": "array",
|
||||||
|
"items": { "type": "string" },
|
||||||
|
"description": "Echoed token from PING (single-element array).",
|
||||||
|
"maxItems": 1
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"required": ["command", "from"],
|
"required": ["command"],
|
||||||
"examples": [
|
"examples": [
|
||||||
{ "command": "PONG", "from": "neoirc" }
|
{ "command": "PONG", "from": "server.example.com", "body": ["1707580000"] }
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,16 +2,16 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PRIVMSG.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/PRIVMSG.json",
|
||||||
"title": "PRIVMSG",
|
"title": "PRIVMSG",
|
||||||
"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.",
|
"description": "Send a message to a channel or user. C2S: client sends to server. S2C: server relays to recipients. RFC 1459 §4.4.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "PRIVMSG" },
|
"command": { "const": "PRIVMSG" },
|
||||||
"from": { "type": "string", "description": "The sender's nick. The server sets it." },
|
"from": { "type": "string", "description": "Sender nick (set by server on relay)." },
|
||||||
"to": { "type": "string", "description": "A channel name, which starts with #, or a nick.", "examples": ["#general", "alice"] },
|
"to": { "type": "string", "description": "Target: #channel or nick.", "examples": ["#general", "alice"] },
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": { "type": "string" },
|
"items": { "type": "string" },
|
||||||
"description": "The lines of the message, one string per line.",
|
"description": "Message lines. One string per line.",
|
||||||
"minItems": 1
|
"minItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@@ -19,6 +19,6 @@
|
|||||||
"examples": [
|
"examples": [
|
||||||
{ "command": "PRIVMSG", "from": "bob", "to": "#general", "body": ["hello world"] },
|
{ "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": "#general", "body": ["line one", "line two"] },
|
||||||
{ "command": "PRIVMSG", "from": "bob", "to": "alice", "body": ["hey"] }
|
{ "command": "PRIVMSG", "from": "bob", "to": "alice", "body": ["hey"], "meta": { "sig": "base64...", "alg": "ed25519" } }
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,37 @@
|
|||||||
|
{
|
||||||
|
"$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",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/QUIT.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/QUIT.json",
|
||||||
"title": "QUIT",
|
"title": "QUIT",
|
||||||
"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.",
|
"description": "User disconnected. S2C only. RFC 1459 §4.1.6.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "QUIT" },
|
"command": { "const": "QUIT" },
|
||||||
"from": { "type": "string", "description": "The nick that quit. The server sets it." },
|
"from": { "type": "string", "description": "Nick that quit." },
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": { "type": "string" },
|
"items": { "type": "string" },
|
||||||
"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."
|
"description": "Optional quit reason.",
|
||||||
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": ["command"],
|
"required": ["command", "from"],
|
||||||
"examples": [
|
"examples": [
|
||||||
{ "command": "QUIT", "body": ["Gone for the day"] },
|
{ "command": "QUIT", "from": "alice", "body": ["Connection reset"] }
|
||||||
{ "command": "QUIT", "from": "alice", "body": ["Connection closed"] }
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,24 +2,20 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/commands/TOPIC.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/commands/TOPIC.json",
|
||||||
"title": "TOPIC",
|
"title": "TOPIC",
|
||||||
"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.",
|
"description": "Get or set channel topic. C2S: set topic (body present) or query (body absent). S2C: topic change notification. RFC 1459 §4.2.4.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": { "const": "TOPIC" },
|
"command": { "const": "TOPIC" },
|
||||||
"from": { "type": "string", "description": "The nick that set the topic. The server sets it." },
|
"from": { "type": "string", "description": "Nick that changed the topic (S2C)." },
|
||||||
"to": {
|
"to": { "type": "string", "description": "Channel name.", "pattern": "^#[a-zA-Z0-9_-]+$" },
|
||||||
"type": "string",
|
|
||||||
"description": "The channel name. The server adds the # if a client leaves it out.",
|
|
||||||
"pattern": "^#?[a-zA-Z0-9_-]{1,63}$"
|
|
||||||
},
|
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": { "type": "string" },
|
"items": { "type": "string" },
|
||||||
"description": "The new topic. The server joins a client's strings with spaces, and sends the topic as one string. [\"\"] clears the topic.",
|
"description": "New topic text (single-element array). Empty array clears the topic.",
|
||||||
"minItems": 1
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": ["command", "to", "body"],
|
"required": ["command", "to"],
|
||||||
"examples": [
|
"examples": [
|
||||||
{ "command": "TOPIC", "from": "alice", "to": "#general", "body": ["Welcome to the channel"] }
|
{ "command": "TOPIC", "from": "alice", "to": "#general", "body": ["Welcome to the channel"] }
|
||||||
]
|
]
|
||||||
|
|||||||
+32
-20
@@ -2,55 +2,67 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/message.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/message.json",
|
||||||
"title": "IRC Message Envelope",
|
"title": "IRC Message Envelope",
|
||||||
"description": "Every message in the HTTP API is one JSON object with these fields. Only 'command' is always present.",
|
"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.).",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"id": {
|
"id": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"format": "uuid",
|
"format": "uuid",
|
||||||
"description": "The message's UUID, which the server assigns. Present on every message the server queues for a client."
|
"description": "Server-assigned message UUID. Present on all server-originated messages."
|
||||||
},
|
},
|
||||||
"command": {
|
"command": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"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.",
|
"description": "IRC command name (PRIVMSG, JOIN, NICK, etc.) or three-digit numeric reply code (001, 353, 433, etc.).",
|
||||||
"examples": ["PRIVMSG", "JOIN", "RPL_WELCOME", "ERR_NICKNAMEINUSE"]
|
"examples": ["PRIVMSG", "JOIN", "001", "353", "433"]
|
||||||
},
|
|
||||||
"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": {
|
"from": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"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."
|
"description": "Source — nick for user messages, server name for server messages. Equivalent to IRC prefix."
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The target: a channel name, such as #general, or a nick. A WALLOPS has * here."
|
"description": "Target — channel (#name) or nick. Equivalent to first IRC parameter for most commands."
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": { "type": "string" },
|
"items": { "type": "string" },
|
||||||
"description": "The message's other parameters, in order. KICK events and many numeric replies have it. The server ignores it from a client."
|
"description": "Additional parameters (used primarily by numeric replies). Equivalent to IRC middle parameters."
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"oneOf": [
|
||||||
"items": { "type": "string" },
|
{
|
||||||
"description": "An array of strings, never a bare string. In a PRIVMSG or NOTICE, each string is one line of text."
|
"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."
|
||||||
},
|
},
|
||||||
"ts": {
|
"ts": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"format": "date-time",
|
"format": "date-time",
|
||||||
"description": "The time the server stored the message, as an RFC 3339 time in UTC."
|
"description": "Server-assigned timestamp (ISO 8601). Not present in original IRC; added for HTTP transport."
|
||||||
},
|
},
|
||||||
"meta": {
|
"meta": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"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.",
|
"description": "Extensible metadata. Used for signatures (meta.sig, meta.alg), hashes (meta.hash), and client extensions.",
|
||||||
"properties": {
|
"properties": {
|
||||||
"hashcash": {
|
"sig": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "A hashcash stamp. A PRIVMSG to a channel with mode +H needs one."
|
"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...')."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": true
|
"additionalProperties": true
|
||||||
|
|||||||
@@ -2,45 +2,32 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/001.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/001.json",
|
||||||
"title": "001 RPL_WELCOME",
|
"title": "001 RPL_WELCOME",
|
||||||
"description": "Welcomes the user. Sent after a session is created, after a login, and in answer to MOTD. RFC 2812 §5.1.",
|
"description": "Welcome message sent after successful session creation. RFC 2812 \u00a75.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_WELCOME"
|
"const": "001"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 1
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The user's nick."
|
"description": "Target nick."
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'Welcome to the network, ' and the user's nick.",
|
"description": "Welcome text lines."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"body"
|
"body"
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "RPL_WELCOME",
|
"command": "001",
|
||||||
"code": 1,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
"to": "alice",
|
||||||
"body": [
|
"body": [
|
||||||
"Welcome to the network, alice"
|
"Welcome to the network, alice"
|
||||||
|
|||||||
@@ -2,48 +2,34 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/002.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/002.json",
|
||||||
"title": "002 RPL_YOURHOST",
|
"title": "002 RPL_YOURHOST",
|
||||||
"description": "The server's name and version. Sent right after RPL_WELCOME. RFC 2812 §5.1.",
|
"description": "Server host info sent after session creation. RFC 2812 \u00a75.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_YOURHOST"
|
"const": "002"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 2
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'Your host is ', the server name, ', running version ' and the version.",
|
"description": "Host info lines."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"body"
|
"body"
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "RPL_YOURHOST",
|
"command": "002",
|
||||||
"code": 2,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
"to": "alice",
|
||||||
"body": [
|
"body": [
|
||||||
"Your host is neoirc, running version dev"
|
"Your host is neoirc.example.com, running version 0.1.0"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -2,45 +2,31 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/003.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/003.json",
|
||||||
"title": "003 RPL_CREATED",
|
"title": "003 RPL_CREATED",
|
||||||
"description": "The date the server last started. Sent right after RPL_YOURHOST. RFC 2812 §5.1.",
|
"description": "Server creation date. RFC 2812 \u00a75.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_CREATED"
|
"const": "003"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 3
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'This server was created ' and the start date as YYYY-MM-DD.",
|
"description": "Text lines."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"body"
|
"body"
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "RPL_CREATED",
|
"command": "003",
|
||||||
"code": 3,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
"to": "alice",
|
||||||
"body": [
|
"body": [
|
||||||
"This server was created 2026-02-01"
|
"This server was created 2026-02-01"
|
||||||
|
|||||||
+10
-37
@@ -2,64 +2,37 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/004.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/004.json",
|
||||||
"title": "004 RPL_MYINFO",
|
"title": "004 RPL_MYINFO",
|
||||||
"description": "The server's name, its version, and its lists of user and channel modes. Sent right after RPL_CREATED. RFC 2812 §5.1.",
|
"description": "Server info (name, version, available modes). RFC 2812 \u00a75.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_MYINFO"
|
"const": "004"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 4
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "The server name, the version, the user modes 'ow' and the channel modes 'Hbiklmnostv'.",
|
"description": "[server_name, version, user_modes, channel_modes]."
|
||||||
"minItems": 4,
|
|
||||||
"maxItems": 4
|
|
||||||
},
|
|
||||||
"body": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"description": "One empty string.",
|
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"params",
|
"params"
|
||||||
"body"
|
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "RPL_MYINFO",
|
"command": "004",
|
||||||
"code": 4,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
"to": "alice",
|
||||||
"params": [
|
"params": [
|
||||||
"neoirc",
|
"neoirc.example.com",
|
||||||
"dev",
|
"0.1.0",
|
||||||
"ow",
|
"o",
|
||||||
"Hbiklmnostv"
|
"imnst+ov"
|
||||||
],
|
|
||||||
"body": [
|
|
||||||
""
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -2,55 +2,38 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/322.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/322.json",
|
||||||
"title": "322 RPL_LIST",
|
"title": "322 RPL_LIST",
|
||||||
"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.",
|
"description": "Channel list entry. One per channel in response to LIST. RFC 1459 \u00a76.2.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_LIST"
|
"const": "322"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 322
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "The channel name and its number of members.",
|
"description": "[channel, visible_count]."
|
||||||
"minItems": 2,
|
|
||||||
"maxItems": 2
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: the channel's topic, empty when it has none.",
|
"description": "Channel topic."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"params",
|
"params"
|
||||||
"body"
|
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "RPL_LIST",
|
"command": "322",
|
||||||
"code": 322,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
"to": "alice",
|
||||||
"params": [
|
"params": [
|
||||||
"#general",
|
"#general",
|
||||||
|
|||||||
@@ -2,49 +2,26 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/323.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/323.json",
|
||||||
"title": "323 RPL_LISTEND",
|
"title": "323 RPL_LISTEND",
|
||||||
"description": "The end of the answer to LIST. RFC 1459 §6.2.",
|
"description": "End of channel list. RFC 1459 \u00a76.2.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_LISTEND"
|
"const": "323"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 323
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'End of /LIST'.",
|
"description": "End of /LIST",
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
"to"
|
||||||
"from",
|
|
||||||
"to",
|
|
||||||
"body"
|
|
||||||
],
|
|
||||||
"examples": [
|
|
||||||
{
|
|
||||||
"command": "RPL_LISTEND",
|
|
||||||
"code": 323,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
|
||||||
"body": [
|
|
||||||
"End of /LIST"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,55 +2,39 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/332.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/332.json",
|
||||||
"title": "332 RPL_TOPIC",
|
"title": "332 RPL_TOPIC",
|
||||||
"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.",
|
"description": "Channel topic (sent on JOIN or TOPIC query). RFC 1459 \u00a76.2.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_TOPIC"
|
"const": "332"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 332
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "The channel name.",
|
"description": "[channel]."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: the topic.",
|
"description": "Topic text."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"params",
|
"params",
|
||||||
"body"
|
"body"
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "RPL_TOPIC",
|
"command": "332",
|
||||||
"code": 332,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
"to": "alice",
|
||||||
"params": [
|
"params": [
|
||||||
"#general"
|
"#general"
|
||||||
|
|||||||
@@ -2,62 +2,46 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/353.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/353.json",
|
||||||
"title": "353 RPL_NAMREPLY",
|
"title": "353 RPL_NAMREPLY",
|
||||||
"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.",
|
"description": "Channel member list. Sent on JOIN or NAMES query. RFC 1459 \u00a76.2.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_NAMREPLY"
|
"const": "353"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 353
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "'=' and the channel name. The server always sends '='.",
|
"description": "[channel_type, channel]. channel_type: = (public), * (private), @ (secret)."
|
||||||
"minItems": 2,
|
|
||||||
"maxItems": 2
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"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.",
|
"description": "Space-separated list of nicks. Prefixed with @ for ops, + for voiced."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"params",
|
"params",
|
||||||
"body"
|
"body"
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "RPL_NAMREPLY",
|
"command": "353",
|
||||||
"code": 353,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
"to": "alice",
|
||||||
"params": [
|
"params": [
|
||||||
"=",
|
"=",
|
||||||
"#general"
|
"#general"
|
||||||
],
|
],
|
||||||
"body": [
|
"body": [
|
||||||
"@op1!op1@host1 alice!alice@host2 +bob!bob@host3"
|
"@op1 alice bob +voiced1"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -2,62 +2,34 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/366.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/366.json",
|
||||||
"title": "366 RPL_ENDOFNAMES",
|
"title": "366 RPL_ENDOFNAMES",
|
||||||
"description": "The end of a channel's member list. It comes after the RPL_NAMREPLY for the channel. RFC 1459 §6.2.",
|
"description": "End of NAMES list. RFC 1459 \u00a76.2.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_ENDOFNAMES"
|
"const": "366"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 366
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "The channel name.",
|
"description": "[channel]."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'End of /NAMES list'.",
|
"description": "End of /NAMES list",
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"params",
|
"params"
|
||||||
"body"
|
|
||||||
],
|
|
||||||
"examples": [
|
|
||||||
{
|
|
||||||
"command": "RPL_ENDOFNAMES",
|
|
||||||
"code": 366,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
|
||||||
"params": [
|
|
||||||
"#general"
|
|
||||||
],
|
|
||||||
"body": [
|
|
||||||
"End of /NAMES list"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,45 +2,31 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/372.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/372.json",
|
||||||
"title": "372 RPL_MOTD",
|
"title": "372 RPL_MOTD",
|
||||||
"description": "One line of the message of the day. The server sends one per line, after RPL_MOTDSTART. RFC 2812 §5.1.",
|
"description": "MOTD line. One message per line of the MOTD. RFC 2812 \u00a75.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_MOTD"
|
"const": "372"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 372
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: '- ' and the line.",
|
"description": "MOTD line text (prefixed with '- ')."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"body"
|
"body"
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "RPL_MOTD",
|
"command": "372",
|
||||||
"code": 372,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
"to": "alice",
|
||||||
"body": [
|
"body": [
|
||||||
"- Welcome to our server!"
|
"- Welcome to our server!"
|
||||||
|
|||||||
@@ -2,49 +2,25 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/375.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/375.json",
|
||||||
"title": "375 RPL_MOTDSTART",
|
"title": "375 RPL_MOTDSTART",
|
||||||
"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.",
|
"description": "Start of MOTD. RFC 2812 \u00a75.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_MOTDSTART"
|
"const": "375"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 375
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: '- ', the server name and ' Message of the Day -'.",
|
"description": "Text lines."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
"to"
|
||||||
"from",
|
|
||||||
"to",
|
|
||||||
"body"
|
|
||||||
],
|
|
||||||
"examples": [
|
|
||||||
{
|
|
||||||
"command": "RPL_MOTDSTART",
|
|
||||||
"code": 375,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
|
||||||
"body": [
|
|
||||||
"- neoirc Message of the Day -"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,49 +2,26 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/376.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/376.json",
|
||||||
"title": "376 RPL_ENDOFMOTD",
|
"title": "376 RPL_ENDOFMOTD",
|
||||||
"description": "The end of the message of the day. RFC 2812 §5.1.",
|
"description": "End of MOTD. RFC 2812 \u00a75.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "RPL_ENDOFMOTD"
|
"const": "376"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 376
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'End of /MOTD command.'.",
|
"description": "End of /MOTD command",
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
"to"
|
||||||
"from",
|
|
||||||
"to",
|
|
||||||
"body"
|
|
||||||
],
|
|
||||||
"examples": [
|
|
||||||
{
|
|
||||||
"command": "RPL_ENDOFMOTD",
|
|
||||||
"code": 376,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
|
||||||
"body": [
|
|
||||||
"End of /MOTD command."
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,61 +2,45 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/401.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/401.json",
|
||||||
"title": "401 ERR_NOSUCHNICK",
|
"title": "401 ERR_NOSUCHNICK",
|
||||||
"description": "No user has that nick. RFC 1459 §6.1.",
|
"description": "No such nick/channel. RFC 1459 \u00a76.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "ERR_NOSUCHNICK"
|
"const": "401"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 401
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "The nick that was not found.",
|
"description": "[target_nick]."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'No such nick' in answer to a PRIVMSG or NOTICE, and 'No such nick/channel' in answer to anything else.",
|
"description": "No such nick/channel",
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"params",
|
"params"
|
||||||
"body"
|
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "ERR_NOSUCHNICK",
|
"command": "401",
|
||||||
"code": 401,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
"to": "alice",
|
||||||
"params": [
|
"params": [
|
||||||
"bob"
|
"bob"
|
||||||
],
|
],
|
||||||
"body": [
|
"body": [
|
||||||
"No such nick"
|
"No such nick/channel"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -2,55 +2,39 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/403.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/403.json",
|
||||||
"title": "403 ERR_NOSUCHCHANNEL",
|
"title": "403 ERR_NOSUCHCHANNEL",
|
||||||
"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.",
|
"description": "No such channel. RFC 1459 \u00a76.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "ERR_NOSUCHCHANNEL"
|
"const": "403"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 403
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "The channel name.",
|
"description": "[channel_name]."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'No such channel'.",
|
"description": "No such channel",
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"params",
|
"params"
|
||||||
"body"
|
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "ERR_NOSUCHCHANNEL",
|
"command": "403",
|
||||||
"code": 403,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
"to": "alice",
|
||||||
"params": [
|
"params": [
|
||||||
"#nonexistent"
|
"#nonexistent"
|
||||||
|
|||||||
@@ -2,58 +2,42 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/433.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/433.json",
|
||||||
"title": "433 ERR_NICKNAMEINUSE",
|
"title": "433 ERR_NICKNAMEINUSE",
|
||||||
"description": "Another user has the nick. Sent in answer to a NICK. RFC 1459 §6.1.",
|
"description": "Nickname is already in use. RFC 1459 \u00a76.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "ERR_NICKNAMEINUSE"
|
"const": "433"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 433
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick, which has not changed."
|
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "The nick that was asked for.",
|
"description": "[requested_nick]."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'Nickname is already in use'.",
|
"description": "Nickname is already in use",
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"params",
|
"params"
|
||||||
"body"
|
|
||||||
],
|
],
|
||||||
"examples": [
|
"examples": [
|
||||||
{
|
{
|
||||||
"command": "ERR_NICKNAMEINUSE",
|
"command": "433",
|
||||||
"code": 433,
|
"to": "*",
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
|
||||||
"params": [
|
"params": [
|
||||||
"bob"
|
"alice"
|
||||||
],
|
],
|
||||||
"body": [
|
"body": [
|
||||||
"Nickname is already in use"
|
"Nickname is already in use"
|
||||||
|
|||||||
@@ -2,62 +2,34 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/442.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/442.json",
|
||||||
"title": "442 ERR_NOTONCHANNEL",
|
"title": "442 ERR_NOTONCHANNEL",
|
||||||
"description": "The user is not on that channel. RFC 1459 §6.1.",
|
"description": "You're not on that channel. RFC 1459 \u00a76.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "ERR_NOTONCHANNEL"
|
"const": "442"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 442
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "The channel name.",
|
"description": "[channel]."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'You're not on that channel'.",
|
"description": "You're not on that channel",
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"to",
|
||||||
"params",
|
"params"
|
||||||
"body"
|
|
||||||
],
|
|
||||||
"examples": [
|
|
||||||
{
|
|
||||||
"command": "ERR_NOTONCHANNEL",
|
|
||||||
"code": 442,
|
|
||||||
"from": "neoirc",
|
|
||||||
"to": "alice",
|
|
||||||
"params": [
|
|
||||||
"#general"
|
|
||||||
],
|
|
||||||
"body": [
|
|
||||||
"You're not on that channel"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,62 +2,34 @@
|
|||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/482.json",
|
"$id": "https://sneak.berlin/go/neoirc/schema/numerics/482.json",
|
||||||
"title": "482 ERR_CHANOPRIVSNEEDED",
|
"title": "482 ERR_CHANOPRIVSNEEDED",
|
||||||
"description": "The user is not a channel operator, and the command needs one. RFC 1459 §6.1.",
|
"description": "You're not channel operator. RFC 1459 \u00a76.1.",
|
||||||
"$ref": "../message.json",
|
"$ref": "../message.json",
|
||||||
"properties": {
|
"properties": {
|
||||||
"command": {
|
"command": {
|
||||||
"const": "ERR_CHANOPRIVSNEEDED"
|
"const": "482"
|
||||||
},
|
|
||||||
"code": {
|
|
||||||
"const": 482
|
|
||||||
},
|
|
||||||
"from": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The server name."
|
|
||||||
},
|
},
|
||||||
"to": {
|
"to": {
|
||||||
"type": "string",
|
"type": "string"
|
||||||
"description": "The user's nick."
|
|
||||||
},
|
},
|
||||||
"params": {
|
"params": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "The channel name.",
|
"description": "[channel]."
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
|
||||||
},
|
},
|
||||||
"body": {
|
"body": {
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "One string: 'You're not channel operator'.",
|
"description": "You're not channel operator",
|
||||||
"minItems": 1,
|
|
||||||
"maxItems": 1
|
"maxItems": 1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
"command",
|
"command",
|
||||||
"code",
|
|
||||||
"from",
|
|
||||||
"to",
|
"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