Compare commits
2
Commits
98a3bf16cd
..
prod
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d6a6296c1e | ||
|
|
12a232ee1b |
@@ -61,10 +61,6 @@ linters:
|
|||||||
desc: >-
|
desc: >-
|
||||||
Test-support code belongs in test files and in packages whose
|
Test-support code belongs in test files and in packages whose
|
||||||
directory name ends in test, not in the shipped binary.
|
directory name ends in test, not in the shipped binary.
|
||||||
- pkg: sneak.berlin/go/neoirc/internal/dbtest
|
|
||||||
desc: >-
|
|
||||||
Test-support code belongs in test files and in packages whose
|
|
||||||
directory name ends in test, not in the shipped binary.
|
|
||||||
# Only decisions already recorded in the Go package defaults are
|
# Only decisions already recorded in the Go package defaults are
|
||||||
# listed here. Every entry matches the module path exactly.
|
# listed here. Every entry matches the module path exactly.
|
||||||
gomodguard_v2:
|
gomodguard_v2:
|
||||||
|
|||||||
@@ -643,10 +643,8 @@ Send a message to a channel or user. This is the primary messaging command.
|
|||||||
message echoed back via the queue).
|
message echoed back via the queue).
|
||||||
- If `to` is a bare nick, the message is a DM. The server fans out to the
|
- If `to` is a bare nick, the message is a DM. The server fans out to the
|
||||||
recipient and the sender (so all of the sender's clients see the DM).
|
recipient and the sender (so all of the sender's clients see the DM).
|
||||||
- A `body` that is not an array of strings, or a `meta` that is not an object,
|
- `body` must be a non-empty array of strings; otherwise the server sends
|
||||||
gets HTTP 400 `invalid request body`, and nothing is relayed. A missing or
|
ERR_NOTEXTTOSEND (412). A missing `to` gets ERR_NORECIPIENT (411).
|
||||||
empty `body` gets ERR_NOTEXTTOSEND (412). A missing `to` gets ERR_NORECIPIENT
|
|
||||||
(411).
|
|
||||||
- Only channel members can send to a channel. A non-member, a banned user, and
|
- Only channel members can send to a channel. A non-member, a banned user, and
|
||||||
on a `+m` channel a user with neither `+o` nor `+v`, get ERR_CANNOTSENDTOCHAN
|
on a `+m` channel a user with neither `+o` nor `+v`, get ERR_CANNOTSENDTOCHAN
|
||||||
(404).
|
(404).
|
||||||
@@ -1238,7 +1236,7 @@ IRC listener sends the usual 3-digit code. Over the HTTP API, 005 arrives named
|
|||||||
| `001` | RPL_WELCOME | After session creation or login, on MOTD | `{"command":"RPL_WELCOME","code":1,"to":"alice","body":["Welcome to the network, alice"]}` |
|
| `001` | RPL_WELCOME | After session creation or login, on MOTD | `{"command":"RPL_WELCOME","code":1,"to":"alice","body":["Welcome to the network, alice"]}` |
|
||||||
| `002` | RPL_YOURHOST | After session creation or login, on MOTD | `{"command":"RPL_YOURHOST","code":2,"to":"alice","body":["Your host is neoirc, running version 0.1"]}` |
|
| `002` | RPL_YOURHOST | After session creation or login, on MOTD | `{"command":"RPL_YOURHOST","code":2,"to":"alice","body":["Your host is neoirc, running version 0.1"]}` |
|
||||||
| `003` | RPL_CREATED | After session creation or login, on MOTD | `{"command":"RPL_CREATED","code":3,"to":"alice","body":["This server was created 2026-02-10"]}` |
|
| `003` | RPL_CREATED | After session creation or login, on MOTD | `{"command":"RPL_CREATED","code":3,"to":"alice","body":["This server was created 2026-02-10"]}` |
|
||||||
| `004` | RPL_MYINFO | After session creation or login, on MOTD | `{"command":"RPL_MYINFO","code":4,"to":"alice","params":["neoirc","0.1","ow","Hbiklmnostv"]}` |
|
| `004` | RPL_MYINFO | After session creation or login, on MOTD | `{"command":"RPL_MYINFO","code":4,"to":"alice","params":["neoirc","0.1","","ikmnostl"]}` |
|
||||||
| `005` | RPL_ISUPPORT | After session creation or login, on MOTD | `{"command":"RPL_BOUNCE","code":5,"to":"alice","params":["CHANTYPES=#","NICKLEN=32","PREFIX=(ov)@+","CHANMODES=b,k,Hl,imnst","NETWORK=neoirc","CASEMAPPING=ascii"],"body":["are supported by this server"]}` |
|
| `005` | RPL_ISUPPORT | After session creation or login, on MOTD | `{"command":"RPL_BOUNCE","code":5,"to":"alice","params":["CHANTYPES=#","NICKLEN=32","PREFIX=(ov)@+","CHANMODES=b,k,Hl,imnst","NETWORK=neoirc","CASEMAPPING=ascii"],"body":["are supported by this server"]}` |
|
||||||
| `221` | RPL_UMODEIS | In response to user MODE | `{"command":"RPL_UMODEIS","code":221,"to":"alice","body":["+"]}` |
|
| `221` | RPL_UMODEIS | In response to user MODE | `{"command":"RPL_UMODEIS","code":221,"to":"alice","body":["+"]}` |
|
||||||
| `251` | RPL_LUSERCLIENT | On connect, MOTD or LUSERS | `{"command":"RPL_LUSERCLIENT","code":251,"to":"alice","body":["There are 5 users and 0 invisible on 1 servers"]}` |
|
| `251` | RPL_LUSERCLIENT | On connect, MOTD or LUSERS | `{"command":"RPL_LUSERCLIENT","code":251,"to":"alice","body":["There are 5 users and 0 invisible on 1 servers"]}` |
|
||||||
@@ -1751,18 +1749,17 @@ command). **Numeric replies**, for success and for errors, are delivered through
|
|||||||
the message queue (see [Numeric Reply Codes](#numeric-reply-codes-s2c-only)); a
|
the message queue (see [Numeric Reply Codes](#numeric-reply-codes-s2c-only)); a
|
||||||
command that has none, such as a successful `PRIVMSG`, is answered by the HTTP
|
command that has none, such as a successful `PRIVMSG`, is answered by the HTTP
|
||||||
response alone, and `PING`'s `PONG` is the HTTP response body. HTTP error codes
|
response alone, and `PING`'s `PONG` is the HTTP response body. HTTP error codes
|
||||||
(4xx/5xx) are reserved for transport-level problems: a malformed request (400),
|
(4xx/5xx) are reserved for transport-level problems: malformed JSON (400),
|
||||||
missing/invalid auth cookies (401), and server errors (500).
|
missing/invalid auth cookies (401), and server errors (500).
|
||||||
|
|
||||||
**HTTP errors (transport-level only):**
|
**HTTP errors (transport-level only):**
|
||||||
|
|
||||||
| Status | Error | When |
|
| Status | Error | When |
|
||||||
| ------ | ---------------------- | ------------------------------------------------------------------------------------------------- |
|
| ------ | ---------------------- | ------------------------------------------------------- |
|
||||||
| 400 | `invalid request body` | Malformed JSON, or a body over `MAX_MESSAGE_SIZE` bytes |
|
| 400 | `invalid request body` | Malformed JSON, or a body over `MAX_MESSAGE_SIZE` bytes |
|
||||||
| 400 | `invalid request body` | A `PRIVMSG` or `NOTICE` whose `body` is not an array of strings, or whose `meta` is not an object |
|
| 400 | `command required` | Empty command |
|
||||||
| 400 | `command required` | Empty command |
|
| 401 | `not registered` | Missing or invalid auth cookie |
|
||||||
| 401 | `not registered` | Missing or invalid auth cookie |
|
| 500 | `internal error` | Server-side failure |
|
||||||
| 500 | `internal error` | Server-side failure |
|
|
||||||
|
|
||||||
**IRC numeric error replies (delivered via message queue):**
|
**IRC numeric error replies (delivered via message queue):**
|
||||||
|
|
||||||
@@ -2614,7 +2611,7 @@ listener.
|
|||||||
| Variable | Type | Default | Description |
|
| Variable | Type | Default | Description |
|
||||||
| ---------------------- | ------ | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ---------------------- | ------ | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `PORT` | int | `8080` | HTTP listen port |
|
| `PORT` | int | `8080` | HTTP listen port |
|
||||||
| `DBURL` | string | `file:///var/lib/neoirc/state.db?_pragma=journal_mode(WAL)&_pragma=busy_timeout(5000)` | SQLite connection string. For file-based: `file:///path/to/db.db?_pragma=journal_mode(WAL)&_pragma=busy_timeout(5000)`. For in-memory (testing): `file::memory:?cache=shared`. It must not set `foreign_keys`. See [SQLite Considerations](#sqlite-considerations). |
|
| `DBURL` | string | `file:///var/lib/neoirc/state.db?_pragma=journal_mode(WAL)&_pragma=busy_timeout(5000)` | SQLite connection string. For file-based: `file:///path/to/db.db?_pragma=journal_mode(WAL)&_pragma=busy_timeout(5000)`. For in-memory (testing): `file::memory:?cache=shared`. See [SQLite Considerations](#sqlite-considerations). |
|
||||||
| `DEBUG` | bool | `false` | Switch logging to debug level |
|
| `DEBUG` | bool | `false` | Switch logging to debug level |
|
||||||
| `MESSAGE_MAX_AGE` | string | `720h` | Maximum age of messages as a Go duration string (e.g. `720h`, `24h`). Messages older than this are pruned. Default is 30 days. |
|
| `MESSAGE_MAX_AGE` | string | `720h` | Maximum age of messages as a Go duration string (e.g. `720h`, `24h`). Messages older than this are pruned. Default is 30 days. |
|
||||||
| `SESSION_IDLE_TIMEOUT` | string | `720h` | Idle timeout as a Go duration string (e.g. `720h`, `24h`). Clients with no authenticated HTTP API request or IRC listener command for this long are removed, and a session left with none is expired and its nick released (see [Data Lifecycle](#data-lifecycle)). Default is 30 days. |
|
| `SESSION_IDLE_TIMEOUT` | string | `720h` | Idle timeout as a Go duration string (e.g. `720h`, `24h`). Clients with no authenticated HTTP API request or IRC listener command for this long are removed, and a session left with none is expired and its nick released (see [Data Lifecycle](#data-lifecycle)). Default is 30 days. |
|
||||||
@@ -3345,7 +3342,6 @@ neoirc/
|
|||||||
│ │ └── schema/
|
│ │ └── schema/
|
||||||
│ │ ├── 000.sql # schema_migrations bootstrap
|
│ │ ├── 000.sql # schema_migrations bootstrap
|
||||||
│ │ └── 001_initial.sql
|
│ │ └── 001_initial.sql
|
||||||
│ ├── dbtest/ # Gives each test its own database; only tests import it
|
|
||||||
│ ├── globals/ # Application-wide metadata
|
│ ├── globals/ # Application-wide metadata
|
||||||
│ │ └── globals.go
|
│ │ └── globals.go
|
||||||
│ ├── handlers/ # HTTP request handlers
|
│ ├── handlers/ # HTTP request handlers
|
||||||
|
|||||||
@@ -25,10 +25,7 @@ const (
|
|||||||
httpErrThreshold = 400
|
httpErrThreshold = 400
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var errHTTP = errors.New("HTTP error")
|
||||||
errHTTP = errors.New("HTTP error")
|
|
||||||
errJoinRefused = errors.New("the server refused the join")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Client wraps HTTP calls to the neoirc server API.
|
// Client wraps HTTP calls to the neoirc server API.
|
||||||
type Client struct {
|
type Client struct {
|
||||||
@@ -209,35 +206,13 @@ func (client *Client) PollMessages(
|
|||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// JoinChannel joins a channel. It returns an error unless the
|
// JoinChannel joins a channel.
|
||||||
// server answers that the session joined. When the server
|
|
||||||
// refuses the join, it sends the reason to the message queue as
|
|
||||||
// an error numeric.
|
|
||||||
func (client *Client) JoinChannel(channel string) error {
|
func (client *Client) JoinChannel(channel string) error {
|
||||||
data, err := client.do(
|
return client.SendMessage(
|
||||||
http.MethodPost, "/api/v1/messages",
|
|
||||||
&Message{ //nolint:exhaustruct // only command+to needed
|
&Message{ //nolint:exhaustruct // only command+to needed
|
||||||
Command: irc.CmdJoin, To: channel,
|
Command: irc.CmdJoin, To: channel,
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
var resp struct {
|
|
||||||
Status string `json:"status"`
|
|
||||||
}
|
|
||||||
|
|
||||||
err = json.Unmarshal(data, &resp)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("decode join: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if resp.Status != "joined" {
|
|
||||||
return errJoinRefused
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// PartChannel leaves a channel.
|
// PartChannel leaves a channel.
|
||||||
|
|||||||
+81
-107
@@ -34,42 +34,28 @@ type App struct {
|
|||||||
|
|
||||||
// Run creates and runs the CLI application.
|
// Run creates and runs the CLI application.
|
||||||
func Run() {
|
func Run() {
|
||||||
err := run(NewUI())
|
|
||||||
if err != nil {
|
|
||||||
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// run starts the client on ui and returns when ui stops. Tests
|
|
||||||
// call it with ui on a simulation screen.
|
|
||||||
func run(ui *UI) error {
|
|
||||||
app := &App{ //nolint:exhaustruct
|
app := &App{ //nolint:exhaustruct
|
||||||
ui: ui,
|
ui: NewUI(),
|
||||||
nick: "guest",
|
nick: "guest",
|
||||||
}
|
}
|
||||||
|
|
||||||
app.ui.OnInput(app.handleInput)
|
app.ui.OnInput(app.handleInput)
|
||||||
|
app.ui.SetStatus(app.nick, "", "disconnected")
|
||||||
|
|
||||||
// SetStatus and AddStatus wait for the event loop, which
|
app.ui.AddStatus(
|
||||||
// app.ui.Run starts below, so they run on a goroutine. The
|
"Welcome to neoirc-cli — an IRC-style client",
|
||||||
// nick is read first, as a typed /nick may change app.nick.
|
)
|
||||||
nick := app.nick
|
app.ui.AddStatus(
|
||||||
|
"Type [yellow]/connect <server-url>" +
|
||||||
|
"[white] to begin, " +
|
||||||
|
"or [yellow]/help[white] for commands",
|
||||||
|
)
|
||||||
|
|
||||||
go func() {
|
err := app.ui.Run()
|
||||||
app.ui.SetStatus(nick, "", "disconnected")
|
if err != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
|
||||||
app.ui.AddStatus(
|
os.Exit(1)
|
||||||
"Welcome to neoirc-cli — an IRC-style client",
|
}
|
||||||
)
|
|
||||||
app.ui.AddStatus(
|
|
||||||
"Type [yellow]/connect <server-url>" +
|
|
||||||
"[white] to begin, " +
|
|
||||||
"or [yellow]/help[white] for commands",
|
|
||||||
)
|
|
||||||
}()
|
|
||||||
|
|
||||||
return app.ui.Run()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *App) handleInput(text string) {
|
func (a *App) handleInput(text string) {
|
||||||
@@ -110,7 +96,20 @@ func (a *App) handleInput(text string) {
|
|||||||
a.ui.AddStatus(
|
a.ui.AddStatus(
|
||||||
"[red]Send error: " + err.Error(),
|
"[red]Send error: " + err.Error(),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
timestamp := time.Now().Format(timeFormat)
|
||||||
|
|
||||||
|
a.mu.Lock()
|
||||||
|
nick := a.nick
|
||||||
|
a.mu.Unlock()
|
||||||
|
|
||||||
|
a.ui.AddLine(target, fmt.Sprintf(
|
||||||
|
"[gray]%s [green]<%s>[white] %s",
|
||||||
|
timestamp, nick, text,
|
||||||
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *App) handleCommand(text string) {
|
func (a *App) handleCommand(text string) {
|
||||||
@@ -199,21 +198,11 @@ func (a *App) cmdConnect(serverURL string) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// The poll loop of an earlier connection is stopped in the same
|
|
||||||
// step that replaces the client, so it never polls with the new
|
|
||||||
// one.
|
|
||||||
a.mu.Lock()
|
a.mu.Lock()
|
||||||
a.client = client
|
a.client = client
|
||||||
a.nick = resp.Nick
|
a.nick = resp.Nick
|
||||||
a.connected = true
|
a.connected = true
|
||||||
a.lastQID = 0
|
a.lastQID = 0
|
||||||
|
|
||||||
if a.stopPoll != nil {
|
|
||||||
close(a.stopPoll)
|
|
||||||
}
|
|
||||||
|
|
||||||
stop := make(chan struct{})
|
|
||||||
a.stopPoll = stop
|
|
||||||
a.mu.Unlock()
|
a.mu.Unlock()
|
||||||
|
|
||||||
a.ui.AddStatus(fmt.Sprintf(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
@@ -222,7 +211,9 @@ func (a *App) cmdConnect(serverURL string) {
|
|||||||
))
|
))
|
||||||
a.ui.SetStatus(resp.Nick, "", "connected")
|
a.ui.SetStatus(resp.Nick, "", "connected")
|
||||||
|
|
||||||
go a.pollLoop(stop)
|
a.stopPoll = make(chan struct{})
|
||||||
|
|
||||||
|
go a.pollLoop()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *App) cmdNick(nick string) {
|
func (a *App) cmdNick(nick string) {
|
||||||
@@ -310,6 +301,9 @@ func (a *App) cmdJoin(channel string) {
|
|||||||
a.mu.Unlock()
|
a.mu.Unlock()
|
||||||
|
|
||||||
a.ui.SwitchToBuffer(channel)
|
a.ui.SwitchToBuffer(channel)
|
||||||
|
a.ui.AddLine(channel,
|
||||||
|
"[yellow]*** Joined "+channel,
|
||||||
|
)
|
||||||
a.ui.SetStatus(nick, channel, "connected")
|
a.ui.SetStatus(nick, channel, "connected")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -344,6 +338,10 @@ func (a *App) cmdPart(channel string) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
a.ui.AddLine(channel,
|
||||||
|
"[yellow]*** Left "+channel,
|
||||||
|
)
|
||||||
|
|
||||||
a.mu.Lock()
|
a.mu.Lock()
|
||||||
if a.target == channel {
|
if a.target == channel {
|
||||||
a.target = ""
|
a.target = ""
|
||||||
@@ -370,6 +368,7 @@ func (a *App) cmdMsg(args string) {
|
|||||||
|
|
||||||
a.mu.Lock()
|
a.mu.Lock()
|
||||||
connected := a.connected
|
connected := a.connected
|
||||||
|
nick := a.nick
|
||||||
a.mu.Unlock()
|
a.mu.Unlock()
|
||||||
|
|
||||||
if !connected {
|
if !connected {
|
||||||
@@ -387,7 +386,16 @@ func (a *App) cmdMsg(args string) {
|
|||||||
a.ui.AddStatus(fmt.Sprintf(
|
a.ui.AddStatus(fmt.Sprintf(
|
||||||
"[red]Send failed: %v", err,
|
"[red]Send failed: %v", err,
|
||||||
))
|
))
|
||||||
|
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
timestamp := time.Now().Format(timeFormat)
|
||||||
|
|
||||||
|
a.ui.AddLine(target, fmt.Sprintf(
|
||||||
|
"[gray]%s [green]<%s>[white] %s",
|
||||||
|
timestamp, nick, text,
|
||||||
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *App) cmdQuery(nick string) {
|
func (a *App) cmdQuery(nick string) {
|
||||||
@@ -632,37 +640,24 @@ func (a *App) cmdWindow(args string) {
|
|||||||
|
|
||||||
_, _ = fmt.Sscanf(args, "%d", &bufIndex)
|
_, _ = fmt.Sscanf(args, "%d", &bufIndex)
|
||||||
|
|
||||||
|
a.ui.SwitchBuffer(bufIndex)
|
||||||
|
|
||||||
a.mu.Lock()
|
a.mu.Lock()
|
||||||
nick := a.nick
|
nick := a.nick
|
||||||
connected := a.connected
|
|
||||||
a.mu.Unlock()
|
a.mu.Unlock()
|
||||||
|
|
||||||
connStatus := "disconnected"
|
if bufIndex >= 0 && bufIndex < a.ui.BufferCount() {
|
||||||
if connected {
|
buf := a.ui.buffers[bufIndex]
|
||||||
connStatus = "connected"
|
if buf.Name != "(status)" {
|
||||||
}
|
|
||||||
|
|
||||||
// Read the name before switching. A message from the server can
|
|
||||||
// add a buffer at any time, but only at the end, so bufIndex
|
|
||||||
// still names this buffer when SwitchBuffer runs.
|
|
||||||
name, found := a.ui.BufferName(bufIndex)
|
|
||||||
if found {
|
|
||||||
a.ui.SwitchBuffer(bufIndex)
|
|
||||||
|
|
||||||
if name != "(status)" {
|
|
||||||
a.mu.Lock()
|
a.mu.Lock()
|
||||||
a.target = name
|
a.target = buf.Name
|
||||||
a.mu.Unlock()
|
a.mu.Unlock()
|
||||||
|
|
||||||
a.ui.SetStatus(
|
a.ui.SetStatus(
|
||||||
nick, name, connStatus,
|
nick, buf.Name, "connected",
|
||||||
)
|
)
|
||||||
} else {
|
} else {
|
||||||
a.mu.Lock()
|
a.ui.SetStatus(nick, "", "connected")
|
||||||
a.target = ""
|
|
||||||
a.mu.Unlock()
|
|
||||||
|
|
||||||
a.ui.SetStatus(nick, "", connStatus)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -710,23 +705,16 @@ func (a *App) cmdHelp() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// pollLoop long-polls for messages in the background until stop is
|
// pollLoop long-polls for messages in the background.
|
||||||
// closed. A later /connect closes stop under a.mu as it replaces the
|
func (a *App) pollLoop() {
|
||||||
// client and the cursor, so the loop checks stop under a.mu too. A
|
|
||||||
// stopped loop then neither polls with the new client nor moves the
|
|
||||||
// new cursor.
|
|
||||||
func (a *App) pollLoop(stop <-chan struct{}) {
|
|
||||||
for {
|
for {
|
||||||
a.mu.Lock()
|
|
||||||
|
|
||||||
select {
|
select {
|
||||||
case <-stop:
|
case <-a.stopPoll:
|
||||||
a.mu.Unlock()
|
|
||||||
|
|
||||||
return
|
return
|
||||||
default:
|
default:
|
||||||
}
|
}
|
||||||
|
|
||||||
|
a.mu.Lock()
|
||||||
client := a.client
|
client := a.client
|
||||||
lastQID := a.lastQID
|
lastQID := a.lastQID
|
||||||
a.mu.Unlock()
|
a.mu.Unlock()
|
||||||
@@ -744,24 +732,12 @@ func (a *App) pollLoop(stop <-chan struct{}) {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
// A poll sent before stop was closed answers for the earlier
|
|
||||||
// connection.
|
|
||||||
a.mu.Lock()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-stop:
|
|
||||||
a.mu.Unlock()
|
|
||||||
|
|
||||||
return
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
|
|
||||||
if result.LastID > 0 {
|
if result.LastID > 0 {
|
||||||
|
a.mu.Lock()
|
||||||
a.lastQID = result.LastID
|
a.lastQID = result.LastID
|
||||||
|
a.mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
a.mu.Unlock()
|
|
||||||
|
|
||||||
for i := range result.Messages {
|
for i := range result.Messages {
|
||||||
a.handleServerMessage(&result.Messages[i])
|
a.handleServerMessage(&result.Messages[i])
|
||||||
}
|
}
|
||||||
@@ -809,10 +785,12 @@ func (a *App) handlePrivmsgEvent(
|
|||||||
lines := msg.BodyLines()
|
lines := msg.BodyLines()
|
||||||
text := strings.Join(lines, " ")
|
text := strings.Join(lines, " ")
|
||||||
|
|
||||||
// A direct message shows in the buffer of the other user:
|
if msg.From == myNick {
|
||||||
// the recipient of one the user sent, else the sender.
|
return
|
||||||
|
}
|
||||||
|
|
||||||
target := msg.To
|
target := msg.To
|
||||||
if !strings.HasPrefix(target, "#") && msg.From != myNick {
|
if !strings.HasPrefix(target, "#") {
|
||||||
target = msg.From
|
target = msg.From
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -835,35 +813,31 @@ func (a *App) handleJoinEvent(
|
|||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
// handlePartEvent shows a part in the channel's buffer. The
|
// handlePartEvent shows another user's part. The server
|
||||||
// user's own part does not mark the channel unread: the user
|
// also sends the user's own part back to it, which cmdPart
|
||||||
// has just left it.
|
// has already shown; showing it again would add a second
|
||||||
|
// line and mark the channel just left as unread.
|
||||||
func (a *App) handlePartEvent(
|
func (a *App) handlePartEvent(
|
||||||
msg *api.Message, timestamp, myNick string,
|
msg *api.Message, timestamp, myNick string,
|
||||||
) {
|
) {
|
||||||
if msg.To == "" {
|
if msg.To == "" || msg.From == myNick {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
lines := msg.BodyLines()
|
lines := msg.BodyLines()
|
||||||
reason := strings.Join(lines, " ")
|
reason := strings.Join(lines, " ")
|
||||||
|
|
||||||
line := fmt.Sprintf(
|
|
||||||
"[gray]%s [yellow]*** %s has left %s",
|
|
||||||
timestamp, msg.From, msg.To,
|
|
||||||
)
|
|
||||||
|
|
||||||
if reason != "" {
|
if reason != "" {
|
||||||
line += " (" + reason + ")"
|
a.ui.AddLine(msg.To, fmt.Sprintf(
|
||||||
|
"[gray]%s [yellow]*** %s has left %s (%s)",
|
||||||
|
timestamp, msg.From, msg.To, reason,
|
||||||
|
))
|
||||||
|
} else {
|
||||||
|
a.ui.AddLine(msg.To, fmt.Sprintf(
|
||||||
|
"[gray]%s [yellow]*** %s has left %s",
|
||||||
|
timestamp, msg.From, msg.To,
|
||||||
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
if msg.From == myNick {
|
|
||||||
a.ui.AddLineAsRead(msg.To, line)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
a.ui.AddLine(msg.To, line)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *App) handleQuitEvent(
|
func (a *App) handleQuitEvent(
|
||||||
|
|||||||
@@ -1,46 +1,13 @@
|
|||||||
package cli
|
package cli
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"io"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"slices"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
|
||||||
|
|
||||||
"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"
|
||||||
"sneak.berlin/go/neoirc/pkg/irc"
|
"sneak.berlin/go/neoirc/pkg/irc"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The user's nick, a channel it is in, another user's nick and
|
|
||||||
// a message text, for the tests below.
|
|
||||||
const (
|
|
||||||
testNick = "erin"
|
|
||||||
testChannel = "#chan"
|
|
||||||
testOtherNick = "bob"
|
|
||||||
testText = "hello"
|
|
||||||
)
|
|
||||||
|
|
||||||
// eventLoopTimeout is how long a test waits for a typed line to
|
|
||||||
// be handled, for the welcome lines, for the UI to stop, for a poll
|
|
||||||
// or for a poll loop to end, before it fails.
|
|
||||||
const eventLoopTimeout = 5 * time.Second
|
|
||||||
|
|
||||||
// holdTime is how long a test waits to see that something does not
|
|
||||||
// happen: the second line handled while the first is held, or a
|
|
||||||
// poll from a poll loop that was stopped.
|
|
||||||
const holdTime = 200 * time.Millisecond
|
|
||||||
|
|
||||||
// welcomeLines is the number of lines run adds to the status
|
|
||||||
// window when the client starts.
|
|
||||||
const welcomeLines = 2
|
|
||||||
|
|
||||||
// checkInterval is how often TestStartUp reads the status window
|
|
||||||
// while it waits for the welcome lines.
|
|
||||||
const checkInterval = 10 * time.Millisecond
|
|
||||||
|
|
||||||
func TestMemberPrefix(t *testing.T) {
|
func TestMemberPrefix(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -86,906 +53,64 @@ func TestMemberPrefix(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// TestPartEvent checks that a PART event adds a line to the
|
// TestPartEvent checks that a PART event adds a line to the
|
||||||
// channel's buffer and marks it unread, except that the
|
// channel's buffer and marks it unread, except for the
|
||||||
// user's own part does not mark it unread.
|
// user's own part, which cmdPart has already shown.
|
||||||
func TestPartEvent(t *testing.T) {
|
func TestPartEvent(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
from string
|
from string
|
||||||
|
wantLines int
|
||||||
wantUnread int
|
wantUnread int
|
||||||
}{
|
}{
|
||||||
{name: "own part", from: testNick, wantUnread: 0},
|
{name: "own part", from: "erin", wantLines: 0, wantUnread: 0},
|
||||||
{name: "other member", from: testOtherNick, wantUnread: 1},
|
{name: "other member", from: "bob", wantLines: 1, wantUnread: 1},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, test := range tests {
|
for _, test := range tests {
|
||||||
t.Run(test.name, func(t *testing.T) {
|
t.Run(test.name, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
app := &App{ui: NewUI(), nick: testNick}
|
app := &App{ui: NewUI(), nick: "erin"}
|
||||||
runUI(t, app.ui)
|
runUI(t, app.ui)
|
||||||
|
|
||||||
app.handleServerMessage(&api.Message{
|
app.handleServerMessage(&api.Message{
|
||||||
Command: irc.CmdPart, From: test.from, To: testChannel,
|
Command: irc.CmdPart, From: test.from, To: "#chan",
|
||||||
})
|
})
|
||||||
|
|
||||||
lines, unread := bufferState(app.ui, testChannel)
|
var lines, unread int
|
||||||
if lines != 1 || unread != test.wantUnread {
|
|
||||||
t.Fatalf("got %d lines and %d unread, want 1 and %d",
|
|
||||||
lines, unread, test.wantUnread)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestOwnCommandShownOnce checks that a message, join or
|
|
||||||
// part made from neoirc-cli shows as one line in the
|
|
||||||
// channel's buffer once the server's event for it arrives,
|
|
||||||
// and does not mark the channel unread.
|
|
||||||
func TestOwnCommandShownOnce(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
send func(app *App)
|
|
||||||
event api.Message
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "message",
|
|
||||||
send: func(app *App) { app.handleInput(testText) },
|
|
||||||
event: api.Message{
|
|
||||||
Command: irc.CmdPrivmsg, From: testNick, To: testChannel,
|
|
||||||
Body: []string{testText},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "join",
|
|
||||||
send: func(app *App) { app.cmdJoin(testChannel) },
|
|
||||||
event: api.Message{
|
|
||||||
Command: irc.CmdJoin, From: testNick, To: testChannel,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "part",
|
|
||||||
send: func(app *App) { app.cmdPart(testChannel) },
|
|
||||||
event: api.Message{
|
|
||||||
Command: irc.CmdPart, From: testNick, To: testChannel,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, test := range tests {
|
|
||||||
t.Run(test.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// The server accepts every command. Only the response
|
|
||||||
// to a JOIN is read, and it says the session joined.
|
|
||||||
server := newServer(t, `{"status": "joined"}`)
|
|
||||||
|
|
||||||
app := &App{
|
|
||||||
ui: NewUI(),
|
|
||||||
client: api.NewClient(server.URL),
|
|
||||||
nick: testNick,
|
|
||||||
target: testChannel,
|
|
||||||
connected: true,
|
|
||||||
}
|
|
||||||
runUI(t, app.ui)
|
|
||||||
app.ui.SwitchToBuffer(testChannel)
|
|
||||||
|
|
||||||
test.send(app)
|
|
||||||
app.handleServerMessage(&test.event)
|
|
||||||
|
|
||||||
lines, unread := bufferState(app.ui, testChannel)
|
|
||||||
if lines != 1 || unread != 0 {
|
|
||||||
t.Fatalf("got %d lines and %d unread, want 1 and 0",
|
|
||||||
lines, unread)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestJoinResponse checks that /join switches to the channel's
|
|
||||||
// buffer and makes it the target only when the server answers
|
|
||||||
// that the session joined.
|
|
||||||
func TestJoinResponse(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
response string
|
|
||||||
// The buffer shown and the target after the join.
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "joined",
|
|
||||||
response: `{"status": "joined", "channel": "#chan"}`,
|
|
||||||
want: testChannel,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "refused",
|
|
||||||
response: `{"status": "error"}`,
|
|
||||||
want: testOtherNick,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, test := range tests {
|
|
||||||
t.Run(test.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
app := &App{
|
|
||||||
ui: NewUI(),
|
|
||||||
client: api.NewClient(newServer(t, test.response).URL),
|
|
||||||
nick: testNick,
|
|
||||||
target: testOtherNick,
|
|
||||||
connected: true,
|
|
||||||
}
|
|
||||||
runUI(t, app.ui)
|
|
||||||
app.ui.SwitchToBuffer(testOtherNick)
|
|
||||||
|
|
||||||
app.cmdJoin(testChannel)
|
|
||||||
|
|
||||||
var shown string
|
|
||||||
|
|
||||||
app.ui.app.QueueUpdate(func() {
|
app.ui.app.QueueUpdate(func() {
|
||||||
shown = app.ui.buffers[app.ui.currentBuffer].Name
|
buf := app.ui.getOrCreateBuffer("#chan")
|
||||||
|
lines = len(buf.Lines)
|
||||||
|
unread = buf.Unread
|
||||||
})
|
})
|
||||||
|
|
||||||
if shown != test.want || app.target != test.want {
|
if lines != test.wantLines || unread != test.wantUnread {
|
||||||
t.Fatalf("got buffer %s and target %s, want %s",
|
t.Fatalf("got %d lines and %d unread, want %d and %d",
|
||||||
shown, app.target, test.want)
|
lines, unread, test.wantLines, test.wantUnread)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestAltDigit checks that Alt and a digit shows that window and
|
|
||||||
// makes its channel or user the target, as /window does. Window
|
|
||||||
// 0, the status window, leaves no target.
|
|
||||||
func TestAltDigit(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
digit rune
|
|
||||||
// The buffer shown and the target after the key.
|
|
||||||
wantBuffer string
|
|
||||||
wantTarget string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "channel window",
|
|
||||||
digit: '1',
|
|
||||||
wantBuffer: testChannel,
|
|
||||||
wantTarget: testChannel,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "status window",
|
|
||||||
digit: '0',
|
|
||||||
wantBuffer: "(status)",
|
|
||||||
wantTarget: "",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, test := range tests {
|
|
||||||
t.Run(test.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
app := &App{ui: NewUI(), nick: testNick, target: testOtherNick}
|
|
||||||
handled := handledLines(app)
|
|
||||||
runUI(t, app.ui)
|
|
||||||
|
|
||||||
// Window 1 is the channel. Window 2, the one shown, is
|
|
||||||
// the other user's.
|
|
||||||
app.ui.SwitchToBuffer(testChannel)
|
|
||||||
app.ui.SwitchToBuffer(testOtherNick)
|
|
||||||
|
|
||||||
key := tcell.NewEventKey(tcell.KeyRune, test.digit, tcell.ModAlt)
|
|
||||||
app.ui.app.QueueEvent(key)
|
|
||||||
waitHandled(t, handled, "/window "+string(test.digit))
|
|
||||||
|
|
||||||
var shown string
|
|
||||||
|
|
||||||
app.ui.app.QueueUpdate(func() {
|
|
||||||
shown = app.ui.buffers[app.ui.currentBuffer].Name
|
|
||||||
})
|
|
||||||
|
|
||||||
if shown != test.wantBuffer || app.target != test.wantTarget {
|
|
||||||
t.Fatalf("got buffer %s and target %q, want %s and %q",
|
|
||||||
shown, app.target, test.wantBuffer, test.wantTarget)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWindowConnectionState checks that typing /window 0, or
|
|
||||||
// pressing Alt and 0, leaves the status bar showing [connected]
|
|
||||||
// only while the client is connected, and [disconnected] otherwise.
|
|
||||||
func TestWindowConnectionState(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const line = "/window 0"
|
|
||||||
|
|
||||||
typeLine := func(ui *UI) {
|
|
||||||
for _, r := range line {
|
|
||||||
ui.app.QueueEvent(tcell.NewEventKey(tcell.KeyRune, r, tcell.ModNone))
|
|
||||||
}
|
|
||||||
|
|
||||||
ui.app.QueueEvent(tcell.NewEventKey(tcell.KeyEnter, 0, tcell.ModNone))
|
|
||||||
}
|
|
||||||
|
|
||||||
pressAltZero := func(ui *UI) {
|
|
||||||
ui.app.QueueEvent(tcell.NewEventKey(tcell.KeyRune, '0', tcell.ModAlt))
|
|
||||||
}
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
send func(ui *UI)
|
|
||||||
connected bool
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "typed line, not connected", send: typeLine,
|
|
||||||
connected: false, want: "[disconnected]",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "Alt and 0, not connected", send: pressAltZero,
|
|
||||||
connected: false, want: "[disconnected]",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "typed line, connected", send: typeLine,
|
|
||||||
connected: true, want: "[connected]",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "Alt and 0, connected", send: pressAltZero,
|
|
||||||
connected: true, want: "[connected]",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
test.send(app.ui)
|
|
||||||
waitHandled(t, handled, line)
|
|
||||||
|
|
||||||
status := statusBarText(app.ui)
|
|
||||||
if !strings.Contains(status, test.want) {
|
|
||||||
t.Fatalf("status bar is %q, want it to show %s", status, test.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestEventLoopKeepsRunning sends Alt and 1, then a typed line and
|
|
||||||
// Enter, to a running UI. It checks that both are handled, so the
|
|
||||||
// event loop did not stop on either.
|
|
||||||
func TestEventLoopKeepsRunning(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
app := &App{ui: NewUI(), nick: testNick}
|
|
||||||
handled := handledLines(app)
|
|
||||||
runUI(t, app.ui)
|
|
||||||
|
|
||||||
// Window 1 is the channel, and window 0, the status window, is
|
|
||||||
// shown. The typed line adds a line to the status window, as
|
|
||||||
// the client is not connected.
|
|
||||||
app.ui.SwitchToBuffer(testChannel)
|
|
||||||
app.ui.SwitchBuffer(0)
|
|
||||||
|
|
||||||
app.ui.app.QueueEvent(tcell.NewEventKey(tcell.KeyRune, '1', tcell.ModAlt))
|
|
||||||
|
|
||||||
for _, r := range testText {
|
|
||||||
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, "/window 1")
|
|
||||||
waitHandled(t, handled, testText)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLinesKeepOrder holds the handling of a first line until a
|
|
||||||
// second line has been passed in. It fails if the second line is
|
|
||||||
// handled while the first is still held.
|
|
||||||
func TestLinesKeepOrder(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const firstLine, secondLine = "one", "two"
|
|
||||||
|
|
||||||
ui := NewUI()
|
|
||||||
handled := make(chan string)
|
|
||||||
release := make(chan struct{})
|
|
||||||
|
|
||||||
ui.OnInput(func(text string) {
|
|
||||||
if text == firstLine {
|
|
||||||
<-release
|
|
||||||
}
|
|
||||||
|
|
||||||
handled <- text
|
|
||||||
})
|
|
||||||
|
|
||||||
ui.callOnInput(firstLine)
|
|
||||||
ui.callOnInput(secondLine)
|
|
||||||
|
|
||||||
select {
|
|
||||||
case got := <-handled:
|
|
||||||
t.Fatalf("handled %q while the first line was held", got)
|
|
||||||
case <-time.After(holdTime):
|
|
||||||
}
|
|
||||||
|
|
||||||
close(release)
|
|
||||||
waitHandled(t, handled, firstLine)
|
|
||||||
waitHandled(t, handled, secondLine)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSecondConnectStopsFirstPollLoop connects to one server, then
|
|
||||||
// to a second that holds every poll. Only the second connection's
|
|
||||||
// poll loop may poll the second server.
|
|
||||||
func TestSecondConnectStopsFirstPollLoop(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const session = `{"id": 1, "nick": "erin"}`
|
|
||||||
|
|
||||||
// The first server answers every request at once, so the first
|
|
||||||
// poll loop polls it until the second /connect.
|
|
||||||
first := newServer(t, session)
|
|
||||||
second, polled := newHoldingServer(t, session)
|
|
||||||
|
|
||||||
app := &App{ui: NewUI(), nick: testNick}
|
|
||||||
runUI(t, app.ui)
|
|
||||||
|
|
||||||
app.cmdConnect(first.URL)
|
|
||||||
app.cmdConnect(second.URL)
|
|
||||||
waitPoll(t, polled, "the second server")
|
|
||||||
|
|
||||||
// The second connection's poll loop waits on its held poll, so
|
|
||||||
// another poll comes from the first loop.
|
|
||||||
select {
|
|
||||||
case <-polled:
|
|
||||||
t.Fatal("the first poll loop polled again after the second /connect")
|
|
||||||
case <-time.After(holdTime):
|
|
||||||
}
|
|
||||||
|
|
||||||
// Stop the second poll loop as /quit does. /quit itself also
|
|
||||||
// stops the UI, and runUI's cleanup stopping it again is a data
|
|
||||||
// race inside tview.
|
|
||||||
app.mu.Lock()
|
|
||||||
close(app.stopPoll)
|
|
||||||
app.mu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSecondConnectIgnoresHeldPoll holds a poll of the earlier
|
|
||||||
// connection at its server while a second /connect runs, then
|
|
||||||
// answers it with a cursor and a message. It fails if that answer
|
|
||||||
// moves the cursor or shows the message.
|
|
||||||
func TestSecondConnectIgnoresHeldPoll(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const session = `{"id": 1, "nick": "erin"}`
|
|
||||||
|
|
||||||
const answer = `{"messages": [{"command": "PRIVMSG", "from": "bob",
|
|
||||||
"to": "#chan", "body": ["hello"]}], "last_id": 42}`
|
|
||||||
|
|
||||||
// The first server sends on polled when the poll arrives, and
|
|
||||||
// answers it once release is closed.
|
|
||||||
polled := make(chan struct{})
|
|
||||||
release := make(chan struct{})
|
|
||||||
first := httptest.NewServer(http.HandlerFunc(
|
|
||||||
func(writer http.ResponseWriter, request *http.Request) {
|
|
||||||
select {
|
|
||||||
case polled <- struct{}{}:
|
|
||||||
case <-request.Context().Done():
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-release:
|
|
||||||
_, _ = io.WriteString(writer, answer)
|
|
||||||
case <-request.Context().Done():
|
|
||||||
}
|
|
||||||
},
|
|
||||||
))
|
|
||||||
t.Cleanup(first.Close)
|
|
||||||
t.Cleanup(first.CloseClientConnections)
|
|
||||||
|
|
||||||
// The second server answers every request at once with the
|
|
||||||
// session. A poll answered with it has no cursor and no messages,
|
|
||||||
// so the second poll loop never moves the cursor.
|
|
||||||
second := newServer(t, session)
|
|
||||||
|
|
||||||
// The test runs the earlier connection's poll loop itself, so
|
|
||||||
// that it can wait for the loop to end.
|
|
||||||
stop := make(chan struct{})
|
|
||||||
app := &App{
|
|
||||||
ui: NewUI(),
|
|
||||||
client: api.NewClient(first.URL),
|
|
||||||
nick: testNick,
|
|
||||||
connected: true,
|
|
||||||
stopPoll: stop,
|
|
||||||
}
|
|
||||||
runUI(t, app.ui)
|
|
||||||
|
|
||||||
done := make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
app.pollLoop(stop)
|
|
||||||
close(done)
|
|
||||||
}()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-polled:
|
|
||||||
case <-time.After(eventLoopTimeout):
|
|
||||||
t.Fatalf("the first server got no poll within %v", eventLoopTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
app.cmdConnect(second.URL)
|
|
||||||
close(release)
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-done:
|
|
||||||
case <-time.After(eventLoopTimeout):
|
|
||||||
t.Fatalf("the earlier poll loop did not end within %v", eventLoopTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
app.mu.Lock()
|
|
||||||
cursor := app.lastQID
|
|
||||||
app.mu.Unlock()
|
|
||||||
|
|
||||||
if cursor != 0 {
|
|
||||||
t.Errorf("the earlier connection's answer moved the cursor to %d", cursor)
|
|
||||||
}
|
|
||||||
|
|
||||||
lines, _ := bufferState(app.ui, testChannel)
|
|
||||||
if lines != 0 {
|
|
||||||
t.Errorf("the earlier connection's message was shown in %s", testChannel)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Stop the second poll loop as /quit does, without stopping the UI.
|
|
||||||
app.mu.Lock()
|
|
||||||
close(app.stopPoll)
|
|
||||||
app.mu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSecondConnectAfterFailedPoll holds a poll of the earlier
|
|
||||||
// connection at its server while a second /connect runs, then
|
|
||||||
// fails it. A poll loop waits pollRetry after a failed poll, then
|
|
||||||
// polls again. The test fails if the earlier poll loop polls the
|
|
||||||
// second server.
|
|
||||||
func TestSecondConnectAfterFailedPoll(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const session = `{"id": 1, "nick": "erin"}`
|
|
||||||
|
|
||||||
first, firstPolled := newHoldingServer(t, session)
|
|
||||||
|
|
||||||
// The second server holds the one poll of the second
|
|
||||||
// connection's poll loop, so any other poll comes from the
|
|
||||||
// earlier loop.
|
|
||||||
second, secondPolled := newHoldingServer(t, session)
|
|
||||||
|
|
||||||
// The test runs the earlier connection's poll loop itself, so
|
|
||||||
// that it can wait for the loop to end.
|
|
||||||
stop := make(chan struct{})
|
|
||||||
app := &App{
|
|
||||||
ui: NewUI(),
|
|
||||||
client: api.NewClient(first.URL),
|
|
||||||
nick: testNick,
|
|
||||||
connected: true,
|
|
||||||
stopPoll: stop,
|
|
||||||
}
|
|
||||||
runUI(t, app.ui)
|
|
||||||
|
|
||||||
done := make(chan struct{})
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
app.pollLoop(stop)
|
|
||||||
close(done)
|
|
||||||
}()
|
|
||||||
|
|
||||||
waitPoll(t, firstPolled, "the first server")
|
|
||||||
app.cmdConnect(second.URL)
|
|
||||||
waitPoll(t, secondPolled, "the second server")
|
|
||||||
|
|
||||||
// Closing the held poll's connection makes that poll fail.
|
|
||||||
first.CloseClientConnections()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-done:
|
|
||||||
case <-secondPolled:
|
|
||||||
t.Fatal("the earlier poll loop polled the second server")
|
|
||||||
case <-time.After(eventLoopTimeout):
|
|
||||||
t.Fatalf("the earlier poll loop did not end within %v", eventLoopTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Stop the second poll loop as /quit does, without stopping the UI.
|
|
||||||
app.mu.Lock()
|
|
||||||
close(app.stopPoll)
|
|
||||||
app.mu.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestStartUp runs the client's start-up path on a simulation
|
|
||||||
// screen. It fails unless the event loop starts and the status
|
|
||||||
// window gets two lines: first the one that holds "Welcome to
|
|
||||||
// neoirc-cli", then the /connect hint. The status bar must show
|
|
||||||
// [disconnected].
|
|
||||||
func TestStartUp(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ui := NewUI()
|
|
||||||
ui.app.SetScreen(tcell.NewSimulationScreen(""))
|
|
||||||
|
|
||||||
// One slot, so that run's goroutine can end even after the
|
|
||||||
// cleanup below has stopped waiting for it.
|
|
||||||
done := make(chan error, 1)
|
|
||||||
|
|
||||||
go func() { done <- run(ui) }()
|
|
||||||
|
|
||||||
t.Cleanup(func() {
|
|
||||||
ui.Stop()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("run: %v", err)
|
|
||||||
}
|
|
||||||
case <-time.After(eventLoopTimeout):
|
|
||||||
t.Error("run did not return after the UI was stopped")
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
// run adds the welcome lines on a goroutine, so the status
|
|
||||||
// window is read until it holds two lines. Each read waits for
|
|
||||||
// the event loop, so the reads run on a goroutine too, which
|
|
||||||
// this test stops waiting for after eventLoopTimeout. The
|
|
||||||
// channel has one slot, so that goroutine can still end.
|
|
||||||
shown := make(chan []string, 1)
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
for {
|
|
||||||
var lines []string
|
|
||||||
|
|
||||||
ui.app.QueueUpdate(func() {
|
|
||||||
lines = slices.Clone(ui.getOrCreateBuffer("(status)").Lines)
|
|
||||||
})
|
|
||||||
|
|
||||||
if len(lines) == welcomeLines {
|
|
||||||
shown <- lines
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
time.Sleep(checkInterval)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
var lines []string
|
|
||||||
|
|
||||||
select {
|
|
||||||
case lines = <-shown:
|
|
||||||
case <-time.After(eventLoopTimeout):
|
|
||||||
t.Fatalf("the status window did not get the welcome lines within %v",
|
|
||||||
eventLoopTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(lines[0], "Welcome to neoirc-cli") {
|
|
||||||
t.Errorf("first status line is %q, want the welcome line", lines[0])
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(lines[1], "/connect <server-url>") {
|
|
||||||
t.Errorf("second status line is %q, want the /connect hint", lines[1])
|
|
||||||
}
|
|
||||||
|
|
||||||
// run sets the status bar before it adds the welcome lines.
|
|
||||||
status := statusBarText(ui)
|
|
||||||
if !strings.Contains(status, "[disconnected]") {
|
|
||||||
t.Errorf("status bar is %q, want it to show [disconnected]", status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestStatusBar checks that the status bar shows [connected], and
|
|
||||||
// shows a nick, target or window name with square brackets as it
|
|
||||||
// is.
|
|
||||||
func TestStatusBar(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
nick string
|
|
||||||
target string
|
|
||||||
unread string
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "plain names",
|
|
||||||
nick: testNick,
|
|
||||||
target: testChannel,
|
|
||||||
unread: testOtherNick,
|
|
||||||
want: " [connected] erin [1:#chan] #chan [Act: 2:bob(1)]",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "nicks with brackets",
|
|
||||||
nick: "erin[away]",
|
|
||||||
target: "bob[m]",
|
|
||||||
unread: "dave[afk]",
|
|
||||||
want: " [connected] erin[away] [1:bob[m]] bob[m] [Act: 2:dave[afk](1)]",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "nicks with brackets and symbols",
|
|
||||||
nick: "bob[|[]",
|
|
||||||
target: "x[^[]",
|
|
||||||
unread: testOtherNick,
|
|
||||||
want: " [connected] bob[|[] [1:x[^[]] x[^[] [Act: 2:bob(1)]",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
// /query takes any text as the target.
|
|
||||||
name: "query target with brackets",
|
|
||||||
nick: testNick,
|
|
||||||
target: "[:::y|z]",
|
|
||||||
unread: testOtherNick,
|
|
||||||
want: " [connected] erin [1:[:::y|z]] [:::y|z] [Act: 2:bob(1)]",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, test := range tests {
|
|
||||||
t.Run(test.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ui := NewUI()
|
|
||||||
runUI(t, ui)
|
|
||||||
|
|
||||||
// Window 1, the one shown, is the target's. Window 2
|
|
||||||
// gets one unread line.
|
|
||||||
ui.SwitchToBuffer(test.target)
|
|
||||||
ui.AddLine(test.unread, testText)
|
|
||||||
ui.SetStatus(test.nick, test.target, "connected")
|
|
||||||
|
|
||||||
got := statusBarText(ui)
|
|
||||||
if got != test.want {
|
|
||||||
t.Fatalf("status bar is %q, want %q", got, test.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestUnreadLine checks that a line added to a window that is not
|
|
||||||
// shown puts that window in the status bar's unread list at once,
|
|
||||||
// and that the status bar keeps the nick, target and connection
|
|
||||||
// state last set.
|
|
||||||
func TestUnreadLine(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
ui := NewUI()
|
|
||||||
runUI(t, ui)
|
|
||||||
|
|
||||||
// Window 1, the one shown, is the channel's. The line goes to
|
|
||||||
// window 2 after SetStatus, so only AddLine can show it in the
|
|
||||||
// status bar.
|
|
||||||
ui.SwitchToBuffer(testChannel)
|
|
||||||
ui.SetStatus(testNick, testChannel, "connected")
|
|
||||||
ui.AddLine(testOtherNick, testText)
|
|
||||||
|
|
||||||
const want = " [connected] erin [1:#chan] #chan [Act: 2:bob(1)]"
|
|
||||||
|
|
||||||
got := statusBarText(ui)
|
|
||||||
if got != want {
|
|
||||||
t.Fatalf("status bar is %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestOwnEventFromOtherClient checks that a message, notice,
|
|
||||||
// join or part that the user's session makes from another
|
|
||||||
// client shows as one line in the buffer it belongs to.
|
|
||||||
func TestOwnEventFromOtherClient(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
event api.Message
|
|
||||||
buffer string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "channel message",
|
|
||||||
event: api.Message{
|
|
||||||
Command: irc.CmdPrivmsg, From: testNick, To: testChannel,
|
|
||||||
Body: []string{testText},
|
|
||||||
},
|
|
||||||
buffer: testChannel,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "direct message",
|
|
||||||
event: api.Message{
|
|
||||||
Command: irc.CmdPrivmsg, From: testNick, To: testOtherNick,
|
|
||||||
Body: []string{testText},
|
|
||||||
},
|
|
||||||
buffer: testOtherNick,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "notice",
|
|
||||||
event: api.Message{
|
|
||||||
Command: irc.CmdNotice, From: testNick, To: testChannel,
|
|
||||||
Body: []string{testText},
|
|
||||||
},
|
|
||||||
buffer: "(status)",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "join",
|
|
||||||
event: api.Message{
|
|
||||||
Command: irc.CmdJoin, From: testNick, To: testChannel,
|
|
||||||
},
|
|
||||||
buffer: testChannel,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "part",
|
|
||||||
event: api.Message{
|
|
||||||
Command: irc.CmdPart, From: testNick, To: testChannel,
|
|
||||||
},
|
|
||||||
buffer: testChannel,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, test := range tests {
|
|
||||||
t.Run(test.name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
app := &App{ui: NewUI(), nick: testNick}
|
|
||||||
runUI(t, app.ui)
|
|
||||||
|
|
||||||
app.handleServerMessage(&test.event)
|
|
||||||
|
|
||||||
lines, _ := bufferState(app.ui, test.buffer)
|
|
||||||
if lines != 1 {
|
|
||||||
t.Fatalf("got %d lines in %s, want 1", lines, test.buffer)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// bufferState returns the number of lines in the named
|
|
||||||
// buffer and how many of them are unread.
|
|
||||||
func bufferState(ui *UI, name string) (int, int) {
|
|
||||||
var lines, unread int
|
|
||||||
|
|
||||||
ui.app.QueueUpdate(func() {
|
|
||||||
buf := ui.getOrCreateBuffer(name)
|
|
||||||
lines = len(buf.Lines)
|
|
||||||
unread = buf.Unread
|
|
||||||
})
|
|
||||||
|
|
||||||
return lines, unread
|
|
||||||
}
|
|
||||||
|
|
||||||
// statusBarText returns the text the status bar shows.
|
|
||||||
// GetText(true) leaves out whatever tview reads as a tag, as
|
|
||||||
// drawing does.
|
|
||||||
func statusBarText(ui *UI) string {
|
|
||||||
var text string
|
|
||||||
|
|
||||||
ui.app.QueueUpdate(func() {
|
|
||||||
text = ui.statusBar.GetText(true)
|
|
||||||
})
|
|
||||||
|
|
||||||
return text
|
|
||||||
}
|
|
||||||
|
|
||||||
// handledLines makes app.ui pass each typed line to
|
|
||||||
// app.handleInput, as Run does, and returns a channel that
|
|
||||||
// receives each line once it has been handled.
|
|
||||||
func handledLines(app *App) <-chan string {
|
|
||||||
handled := make(chan string)
|
|
||||||
|
|
||||||
app.ui.OnInput(func(text string) {
|
|
||||||
app.handleInput(text)
|
|
||||||
|
|
||||||
handled <- text
|
|
||||||
})
|
|
||||||
|
|
||||||
return handled
|
|
||||||
}
|
|
||||||
|
|
||||||
// waitHandled fails the test unless want is the next line handled,
|
|
||||||
// within eventLoopTimeout.
|
|
||||||
func waitHandled(t *testing.T, handled <-chan string, want string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case got := <-handled:
|
|
||||||
if got != want {
|
|
||||||
t.Fatalf("handled %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
case <-time.After(eventLoopTimeout):
|
|
||||||
t.Fatalf("%q was not handled within %v", want, eventLoopTimeout)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// newServer starts a server that answers every request with
|
|
||||||
// body until the test ends.
|
|
||||||
func newServer(t *testing.T, body string) *httptest.Server {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
server := httptest.NewServer(http.HandlerFunc(
|
|
||||||
func(writer http.ResponseWriter, _ *http.Request) {
|
|
||||||
_, _ = io.WriteString(writer, body)
|
|
||||||
},
|
|
||||||
))
|
|
||||||
t.Cleanup(server.Close)
|
|
||||||
|
|
||||||
return server
|
|
||||||
}
|
|
||||||
|
|
||||||
// newHoldingServer starts a server that sends on the returned
|
|
||||||
// channel for each poll and holds the poll until its connection
|
|
||||||
// closes. It answers any other request with body.
|
|
||||||
func newHoldingServer(
|
|
||||||
t *testing.T, body string,
|
|
||||||
) (*httptest.Server, <-chan struct{}) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
polled := make(chan struct{})
|
|
||||||
server := httptest.NewServer(http.HandlerFunc(
|
|
||||||
func(writer http.ResponseWriter, request *http.Request) {
|
|
||||||
if request.Method != http.MethodGet ||
|
|
||||||
request.URL.Path != "/api/v1/messages" {
|
|
||||||
_, _ = io.WriteString(writer, body)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
select {
|
|
||||||
case polled <- struct{}{}:
|
|
||||||
case <-request.Context().Done():
|
|
||||||
}
|
|
||||||
|
|
||||||
<-request.Context().Done()
|
|
||||||
},
|
|
||||||
))
|
|
||||||
// Close waits for the held polls, which end only once their
|
|
||||||
// connections close. Cleanups run last first, so the connections
|
|
||||||
// close before Close runs.
|
|
||||||
t.Cleanup(server.Close)
|
|
||||||
t.Cleanup(server.CloseClientConnections)
|
|
||||||
|
|
||||||
return server, polled
|
|
||||||
}
|
|
||||||
|
|
||||||
// waitPoll fails the test unless server gets a poll, sent on
|
|
||||||
// polled, within eventLoopTimeout.
|
|
||||||
func waitPoll(t *testing.T, polled <-chan struct{}, server string) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-polled:
|
|
||||||
case <-time.After(eventLoopTimeout):
|
|
||||||
t.Fatalf("%s got no poll within %v", server, eventLoopTimeout)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// runUI runs ui on a simulated screen until the test ends.
|
// runUI runs ui on a simulated screen until the test ends.
|
||||||
func runUI(t *testing.T, ui *UI) {
|
func runUI(t *testing.T, ui *UI) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
ui.app.SetScreen(tcell.NewSimulationScreen(""))
|
ui.app.SetScreen(tcell.NewSimulationScreen(""))
|
||||||
|
|
||||||
// One slot, so that Run's goroutine can end even after the
|
done := make(chan error)
|
||||||
// cleanup below has stopped waiting for it.
|
|
||||||
done := make(chan error, 1)
|
|
||||||
|
|
||||||
go func() { done <- ui.Run() }()
|
go func() { done <- ui.Run() }()
|
||||||
|
|
||||||
t.Cleanup(func() {
|
t.Cleanup(func() {
|
||||||
ui.Stop()
|
ui.Stop()
|
||||||
|
|
||||||
select {
|
err := <-done
|
||||||
case err := <-done:
|
if err != nil {
|
||||||
if err != nil {
|
t.Errorf("run ui: %v", err)
|
||||||
t.Errorf("run ui: %v", err)
|
|
||||||
}
|
|
||||||
case <-time.After(eventLoopTimeout):
|
|
||||||
t.Error("the UI did not stop: its event loop stopped responding")
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+14
-86
@@ -16,10 +16,7 @@ type Buffer struct {
|
|||||||
Unread int
|
Unread int
|
||||||
}
|
}
|
||||||
|
|
||||||
// UI manages the terminal interface. Most of its methods wait for
|
// UI manages the terminal interface.
|
||||||
// the tview event loop to run their update. Code that runs on that
|
|
||||||
// loop, such as a key handler, must not call them: it would wait
|
|
||||||
// for itself.
|
|
||||||
type UI struct {
|
type UI struct {
|
||||||
app *tview.Application
|
app *tview.Application
|
||||||
messages *tview.TextView
|
messages *tview.TextView
|
||||||
@@ -30,17 +27,7 @@ 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
|
|
||||||
// has been handled. Only callOnInput, on the event loop, uses
|
|
||||||
// it.
|
|
||||||
inputDone chan struct{}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewUI creates the tview-based IRC-like UI.
|
// NewUI creates the tview-based IRC-like UI.
|
||||||
@@ -108,19 +95,6 @@ func (ui *UI) AddLine(bufferName, line string) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// AddLineAsRead adds a line to the specified buffer, as
|
|
||||||
// AddLine does, but does not mark the buffer unread.
|
|
||||||
func (ui *UI) AddLineAsRead(bufferName, line string) {
|
|
||||||
ui.app.QueueUpdateDraw(func() {
|
|
||||||
buf := ui.getOrCreateBuffer(bufferName)
|
|
||||||
buf.Lines = append(buf.Lines, line)
|
|
||||||
|
|
||||||
if ui.buffers[ui.currentBuffer] == buf {
|
|
||||||
_, _ = fmt.Fprintln(ui.messages, line)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddStatus adds a line to the status buffer.
|
// AddStatus adds a line to the status buffer.
|
||||||
func (ui *UI) AddStatus(line string) {
|
func (ui *UI) AddStatus(line string) {
|
||||||
ts := time.Now().Format("15:04")
|
ts := time.Now().Format("15:04")
|
||||||
@@ -185,32 +159,13 @@ 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()
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// BufferName returns the name of the buffer at index bufIndex,
|
// BufferCount returns the number of buffers.
|
||||||
// and whether there is such a buffer.
|
func (ui *UI) BufferCount() int {
|
||||||
func (ui *UI) BufferName(bufIndex int) (string, bool) {
|
return len(ui.buffers)
|
||||||
var (
|
|
||||||
name string
|
|
||||||
found bool
|
|
||||||
)
|
|
||||||
|
|
||||||
ui.app.QueueUpdate(func() {
|
|
||||||
if bufIndex < 0 || bufIndex >= len(ui.buffers) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
name = ui.buffers[bufIndex].Name
|
|
||||||
found = true
|
|
||||||
})
|
|
||||||
|
|
||||||
return name, found
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// BufferIndex returns the index of a named buffer.
|
// BufferIndex returns the index of a named buffer.
|
||||||
@@ -236,10 +191,8 @@ func (ui *UI) initMessages() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (ui *UI) initStatusBar() {
|
func (ui *UI) initStatusBar() {
|
||||||
// Colour tags stay off. With them on, tview reads text in
|
ui.statusBar = tview.NewTextView().
|
||||||
// square brackets, such as "[connected]" or part of a nick,
|
SetDynamicColors(true)
|
||||||
// as a tag and drops it.
|
|
||||||
ui.statusBar = tview.NewTextView()
|
|
||||||
ui.statusBar.SetBackgroundColor(tcell.ColorNavy)
|
ui.statusBar.SetBackgroundColor(tcell.ColorNavy)
|
||||||
ui.statusBar.SetTextColor(tcell.ColorWhite)
|
ui.statusBar.SetTextColor(tcell.ColorWhite)
|
||||||
}
|
}
|
||||||
@@ -260,7 +213,10 @@ func (ui *UI) initInput() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
ui.input.SetText("")
|
ui.input.SetText("")
|
||||||
ui.callOnInput(text)
|
|
||||||
|
if ui.onInput != nil {
|
||||||
|
ui.onInput(text)
|
||||||
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -271,11 +227,10 @@ func (ui *UI) initKeyCapture() {
|
|||||||
return event
|
return event
|
||||||
}
|
}
|
||||||
|
|
||||||
// Alt and a digit runs /window with that digit.
|
|
||||||
// SwitchBuffer alone would leave the target as it was.
|
|
||||||
r := event.Rune()
|
r := event.Rune()
|
||||||
if r >= '0' && r <= '9' {
|
if r >= '0' && r <= '9' {
|
||||||
ui.callOnInput("/window " + string(r))
|
idx := int(r - '0')
|
||||||
|
ui.SwitchBuffer(idx)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -285,35 +240,8 @@ func (ui *UI) initKeyCapture() {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// callOnInput passes text to the input callback on a new
|
|
||||||
// goroutine. The key handlers call it on the event loop, and the
|
|
||||||
// callback waits for that loop to update the screen, so they must
|
|
||||||
// not wait for the callback. The goroutine first waits for the
|
|
||||||
// line before it to be handled, which keeps lines in the order
|
|
||||||
// they were typed.
|
|
||||||
func (ui *UI) callOnInput(text string) {
|
|
||||||
if ui.onInput == nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
previous := ui.inputDone
|
|
||||||
done := make(chan struct{})
|
|
||||||
ui.inputDone = done
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
if previous != nil {
|
|
||||||
<-previous
|
|
||||||
}
|
|
||||||
|
|
||||||
ui.onInput(text)
|
|
||||||
close(done)
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
|
|
||||||
// refreshStatusBar redraws the status bar with the nick, target
|
|
||||||
// and connection state last passed to SetStatus.
|
|
||||||
func (ui *UI) refreshStatusBar() {
|
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(
|
||||||
|
|||||||
+7
-103
@@ -3,12 +3,8 @@ package config
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"math"
|
|
||||||
"os"
|
"os"
|
||||||
"strconv"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/spf13/viper"
|
"github.com/spf13/viper"
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
@@ -32,8 +28,6 @@ Type /help for available commands.`
|
|||||||
const DefaultDBURL = "file:///var/lib/neoirc/state.db" +
|
const DefaultDBURL = "file:///var/lib/neoirc/state.db" +
|
||||||
"?_pragma=journal_mode(WAL)&_pragma=busy_timeout(5000)"
|
"?_pragma=journal_mode(WAL)&_pragma=busy_timeout(5000)"
|
||||||
|
|
||||||
var errOutOfRange = errors.New("setting out of range")
|
|
||||||
|
|
||||||
// Params defines the dependencies for creating a Config.
|
// Params defines the dependencies for creating a Config.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -69,8 +63,6 @@ type Config struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// New creates a new Config by reading from files and environment variables.
|
// New creates a new Config by reading from files and environment variables.
|
||||||
// It returns an error when a number, true/false or duration setting does
|
|
||||||
// not parse or is out of range.
|
|
||||||
func New(
|
func New(
|
||||||
_ fx.Lifecycle, params Params,
|
_ fx.Lifecycle, params Params,
|
||||||
) (*Config, error) {
|
) (*Config, error) {
|
||||||
@@ -115,27 +107,29 @@ func New(
|
|||||||
|
|
||||||
cfg := &Config{
|
cfg := &Config{
|
||||||
DBURL: viper.GetString("DBURL"),
|
DBURL: viper.GetString("DBURL"),
|
||||||
|
Debug: viper.GetBool("DEBUG"),
|
||||||
|
Port: viper.GetInt("PORT"),
|
||||||
SentryDSN: viper.GetString("SENTRY_DSN"),
|
SentryDSN: viper.GetString("SENTRY_DSN"),
|
||||||
|
MaintenanceMode: viper.GetBool("MAINTENANCE_MODE"),
|
||||||
MetricsUsername: viper.GetString("METRICS_USERNAME"),
|
MetricsUsername: viper.GetString("METRICS_USERNAME"),
|
||||||
MetricsPassword: viper.GetString("METRICS_PASSWORD"),
|
MetricsPassword: viper.GetString("METRICS_PASSWORD"),
|
||||||
MessageMaxAge: viper.GetString("MESSAGE_MAX_AGE"),
|
MessageMaxAge: viper.GetString("MESSAGE_MAX_AGE"),
|
||||||
|
MaxMessageSize: viper.GetInt("MAX_MESSAGE_SIZE"),
|
||||||
QueueMaxAge: viper.GetString("QUEUE_MAX_AGE"),
|
QueueMaxAge: viper.GetString("QUEUE_MAX_AGE"),
|
||||||
MOTD: viper.GetString("MOTD"),
|
MOTD: viper.GetString("MOTD"),
|
||||||
ServerName: viper.GetString("SERVER_NAME"),
|
ServerName: viper.GetString("SERVER_NAME"),
|
||||||
FederationKey: viper.GetString("FEDERATION_KEY"),
|
FederationKey: viper.GetString("FEDERATION_KEY"),
|
||||||
SessionIdleTimeout: viper.GetString("SESSION_IDLE_TIMEOUT"),
|
SessionIdleTimeout: viper.GetString("SESSION_IDLE_TIMEOUT"),
|
||||||
|
HashcashBits: viper.GetInt("NEOIRC_HASHCASH_BITS"),
|
||||||
OperName: viper.GetString("NEOIRC_OPER_NAME"),
|
OperName: viper.GetString("NEOIRC_OPER_NAME"),
|
||||||
OperPassword: viper.GetString("NEOIRC_OPER_PASSWORD"),
|
OperPassword: viper.GetString("NEOIRC_OPER_PASSWORD"),
|
||||||
|
LoginRateLimit: viper.GetFloat64("LOGIN_RATE_LIMIT"),
|
||||||
|
LoginRateBurst: viper.GetInt("LOGIN_RATE_BURST"),
|
||||||
IRCListenAddr: viper.GetString("IRC_LISTEN_ADDR"),
|
IRCListenAddr: viper.GetString("IRC_LISTEN_ADDR"),
|
||||||
log: log,
|
log: log,
|
||||||
params: ¶ms,
|
params: ¶ms,
|
||||||
}
|
}
|
||||||
|
|
||||||
err = parseSettings(cfg)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Viper counts an empty environment variable as unset, but an
|
// Viper counts an empty environment variable as unset, but an
|
||||||
// empty IRC_LISTEN_ADDR must turn the IRC listener off.
|
// empty IRC_LISTEN_ADDR must turn the IRC listener off.
|
||||||
ircListenAddr, set := os.LookupEnv("IRC_LISTEN_ADDR")
|
ircListenAddr, set := os.LookupEnv("IRC_LISTEN_ADDR")
|
||||||
@@ -150,93 +144,3 @@ func New(
|
|||||||
|
|
||||||
return cfg, nil
|
return cfg, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// parseSettings reads the number and true/false settings into cfg and
|
|
||||||
// checks the duration settings. Each number and duration must be above
|
|
||||||
// zero. PORT and NEOIRC_HASHCASH_BITS may also be zero: port 0 lets the
|
|
||||||
// system pick a port, and 0 bits turns proof of work off. The error
|
|
||||||
// names each setting that does not parse or is out of range.
|
|
||||||
func parseSettings(cfg *Config) error {
|
|
||||||
return errors.Join(
|
|
||||||
parseInt("PORT", 0, &cfg.Port),
|
|
||||||
parseInt("MAX_MESSAGE_SIZE", 1, &cfg.MaxMessageSize),
|
|
||||||
parseInt("NEOIRC_HASHCASH_BITS", 0, &cfg.HashcashBits),
|
|
||||||
parseInt("LOGIN_RATE_BURST", 1, &cfg.LoginRateBurst),
|
|
||||||
parseFloat("LOGIN_RATE_LIMIT", &cfg.LoginRateLimit),
|
|
||||||
parseBool("DEBUG", &cfg.Debug),
|
|
||||||
parseBool("MAINTENANCE_MODE", &cfg.MaintenanceMode),
|
|
||||||
checkDuration("MESSAGE_MAX_AGE", cfg.MessageMaxAge),
|
|
||||||
checkDuration("QUEUE_MAX_AGE", cfg.QueueMaxAge),
|
|
||||||
checkDuration("SESSION_IDLE_TIMEOUT", cfg.SessionIdleTimeout),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseInt sets *value to the setting key read as a whole number. It
|
|
||||||
// returns an error when the value does not parse or is below minimum.
|
|
||||||
func parseInt(key string, minimum int, value *int) error {
|
|
||||||
raw := viper.GetString(key)
|
|
||||||
|
|
||||||
parsed, err := strconv.Atoi(raw)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("cannot parse %s: %w", key, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if parsed < minimum {
|
|
||||||
return fmt.Errorf("%w: %s is %s, but must be at least %d",
|
|
||||||
errOutOfRange, key, raw, minimum)
|
|
||||||
}
|
|
||||||
|
|
||||||
*value = parsed
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseFloat sets *value to the setting key read as a floating-point
|
|
||||||
// number. It returns an error when the value does not parse or is not a
|
|
||||||
// finite number above zero.
|
|
||||||
func parseFloat(key string, value *float64) error {
|
|
||||||
raw := viper.GetString(key)
|
|
||||||
|
|
||||||
parsed, err := strconv.ParseFloat(raw, 64)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("cannot parse %s: %w", key, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if math.IsNaN(parsed) || math.IsInf(parsed, 0) || parsed <= 0 {
|
|
||||||
return fmt.Errorf(
|
|
||||||
"%w: %s is %s, but must be a finite number above zero",
|
|
||||||
errOutOfRange, key, raw)
|
|
||||||
}
|
|
||||||
|
|
||||||
*value = parsed
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseBool sets *value to the setting key read as true or false.
|
|
||||||
func parseBool(key string, value *bool) error {
|
|
||||||
parsed, err := strconv.ParseBool(viper.GetString(key))
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("cannot parse %s: %w", key, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
*value = parsed
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// checkDuration returns an error naming the setting key when value is
|
|
||||||
// not a Go duration above zero.
|
|
||||||
func checkDuration(key, value string) error {
|
|
||||||
duration, err := time.ParseDuration(value)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("cannot parse %s: %w", key, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if duration <= 0 {
|
|
||||||
return fmt.Errorf("%w: %s is %s, but must be above zero",
|
|
||||||
errOutOfRange, key, value)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package config_test
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
"strings"
|
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -11,8 +10,7 @@ import (
|
|||||||
"sneak.berlin/go/neoirc/internal/logger"
|
"sneak.berlin/go/neoirc/internal/logger"
|
||||||
)
|
)
|
||||||
|
|
||||||
// loadConfig runs config.New and returns its result.
|
func newConfig(t *testing.T) *config.Config {
|
||||||
func loadConfig(t *testing.T) (*config.Config, error) {
|
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
globs := &globals.Globals{
|
globs := &globals.Globals{
|
||||||
@@ -26,15 +24,9 @@ func loadConfig(t *testing.T) (*config.Config, error) {
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return config.New(
|
cfg, err := config.New(
|
||||||
nil, config.Params{Globals: globs, Logger: log},
|
nil, config.Params{Globals: globs, Logger: log},
|
||||||
)
|
)
|
||||||
}
|
|
||||||
|
|
||||||
func newConfig(t *testing.T) *config.Config {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
cfg, err := loadConfig(t)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -42,145 +34,6 @@ func newConfig(t *testing.T) *config.Config {
|
|||||||
return cfg
|
return cfg
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestUnsetSettingsKeepDefaults(t *testing.T) {
|
|
||||||
// Viper counts an empty environment variable as unset.
|
|
||||||
t.Setenv("PORT", "")
|
|
||||||
t.Setenv("MAX_MESSAGE_SIZE", "")
|
|
||||||
t.Setenv("NEOIRC_HASHCASH_BITS", "")
|
|
||||||
t.Setenv("LOGIN_RATE_BURST", "")
|
|
||||||
t.Setenv("LOGIN_RATE_LIMIT", "")
|
|
||||||
t.Setenv("DEBUG", "")
|
|
||||||
t.Setenv("MAINTENANCE_MODE", "")
|
|
||||||
t.Setenv("MESSAGE_MAX_AGE", "")
|
|
||||||
t.Setenv("QUEUE_MAX_AGE", "")
|
|
||||||
t.Setenv("SESSION_IDLE_TIMEOUT", "")
|
|
||||||
|
|
||||||
// Each duration setting defaults to 30 days.
|
|
||||||
const thirtyDays = "720h"
|
|
||||||
|
|
||||||
want := settings{
|
|
||||||
Port: 8080,
|
|
||||||
MaxMessageSize: 4096,
|
|
||||||
HashcashBits: 20,
|
|
||||||
LoginRateBurst: 5,
|
|
||||||
LoginRateLimit: 1,
|
|
||||||
Debug: false,
|
|
||||||
MaintenanceMode: false,
|
|
||||||
MessageMaxAge: thirtyDays,
|
|
||||||
QueueMaxAge: thirtyDays,
|
|
||||||
SessionIdleTimeout: thirtyDays,
|
|
||||||
}
|
|
||||||
|
|
||||||
got := settingsOf(newConfig(t))
|
|
||||||
if got != want {
|
|
||||||
t.Errorf("settings = %+v, want %+v", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestValidSettingsAreUsed(t *testing.T) {
|
|
||||||
// Each whole number is the lowest value its setting allows, and 1ns
|
|
||||||
// is the shortest duration allowed.
|
|
||||||
t.Setenv("PORT", "0")
|
|
||||||
t.Setenv("MAX_MESSAGE_SIZE", "1")
|
|
||||||
t.Setenv("NEOIRC_HASHCASH_BITS", "0")
|
|
||||||
t.Setenv("LOGIN_RATE_BURST", "1")
|
|
||||||
t.Setenv("LOGIN_RATE_LIMIT", "0.5")
|
|
||||||
t.Setenv("DEBUG", "true")
|
|
||||||
t.Setenv("MAINTENANCE_MODE", "true")
|
|
||||||
t.Setenv("MESSAGE_MAX_AGE", "1ns")
|
|
||||||
t.Setenv("QUEUE_MAX_AGE", "1h30m")
|
|
||||||
t.Setenv("SESSION_IDLE_TIMEOUT", "45m")
|
|
||||||
|
|
||||||
want := settings{
|
|
||||||
Port: 0,
|
|
||||||
MaxMessageSize: 1,
|
|
||||||
HashcashBits: 0,
|
|
||||||
LoginRateBurst: 1,
|
|
||||||
LoginRateLimit: 0.5,
|
|
||||||
Debug: true,
|
|
||||||
MaintenanceMode: true,
|
|
||||||
MessageMaxAge: "1ns",
|
|
||||||
QueueMaxAge: "1h30m",
|
|
||||||
SessionIdleTimeout: "45m",
|
|
||||||
}
|
|
||||||
|
|
||||||
got := settingsOf(newConfig(t))
|
|
||||||
if got != want {
|
|
||||||
t.Errorf("settings = %+v, want %+v", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// settings holds the Config fields whose settings config.New parses.
|
|
||||||
type settings struct {
|
|
||||||
Port int
|
|
||||||
MaxMessageSize int
|
|
||||||
HashcashBits int
|
|
||||||
LoginRateBurst int
|
|
||||||
LoginRateLimit float64
|
|
||||||
Debug bool
|
|
||||||
MaintenanceMode bool
|
|
||||||
MessageMaxAge string
|
|
||||||
QueueMaxAge string
|
|
||||||
SessionIdleTimeout string
|
|
||||||
}
|
|
||||||
|
|
||||||
func settingsOf(cfg *config.Config) settings {
|
|
||||||
return settings{
|
|
||||||
Port: cfg.Port,
|
|
||||||
MaxMessageSize: cfg.MaxMessageSize,
|
|
||||||
HashcashBits: cfg.HashcashBits,
|
|
||||||
LoginRateBurst: cfg.LoginRateBurst,
|
|
||||||
LoginRateLimit: cfg.LoginRateLimit,
|
|
||||||
Debug: cfg.Debug,
|
|
||||||
MaintenanceMode: cfg.MaintenanceMode,
|
|
||||||
MessageMaxAge: cfg.MessageMaxAge,
|
|
||||||
QueueMaxAge: cfg.QueueMaxAge,
|
|
||||||
SessionIdleTimeout: cfg.SessionIdleTimeout,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestBadSettingStopsStartup(t *testing.T) {
|
|
||||||
// For each setting, the first value does not parse and the others
|
|
||||||
// parse but are out of range.
|
|
||||||
tests := []struct {
|
|
||||||
key string
|
|
||||||
values []string
|
|
||||||
}{
|
|
||||||
{key: "PORT", values: []string{"80a", "-1"}},
|
|
||||||
{key: "MAX_MESSAGE_SIZE", values: []string{"4k", "0", "-4096"}},
|
|
||||||
{key: "NEOIRC_HASHCASH_BITS", values: []string{"twenty", "-1"}},
|
|
||||||
{key: "LOGIN_RATE_BURST", values: []string{"five", "0", "-5"}},
|
|
||||||
{key: "LOGIN_RATE_LIMIT", values: []string{
|
|
||||||
"fast", "0", "-1", "NaN", "Inf", "-Inf",
|
|
||||||
}},
|
|
||||||
{key: "DEBUG", values: []string{"yes"}},
|
|
||||||
{key: "MAINTENANCE_MODE", values: []string{"on"}},
|
|
||||||
{key: "MESSAGE_MAX_AGE", values: []string{"30d", "0", "-1h"}},
|
|
||||||
{key: "QUEUE_MAX_AGE", values: []string{"720", "0s", "-24h"}},
|
|
||||||
{key: "SESSION_IDLE_TIMEOUT", values: []string{"a month", "0", "-1m"}},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, test := range tests {
|
|
||||||
for _, value := range test.values {
|
|
||||||
t.Run(test.key+"="+value, func(t *testing.T) {
|
|
||||||
t.Setenv(test.key, value)
|
|
||||||
|
|
||||||
_, err := loadConfig(t)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatalf("%s=%q: got no error", test.key, value)
|
|
||||||
}
|
|
||||||
|
|
||||||
msg := err.Error()
|
|
||||||
if !strings.Contains(msg, test.key) ||
|
|
||||||
!strings.Contains(msg, value) {
|
|
||||||
t.Errorf("error %q does not name %s and %q",
|
|
||||||
msg, test.key, value)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIRCListenAddrUnsetKeepsDefault(t *testing.T) {
|
func TestIRCListenAddrUnsetKeepsDefault(t *testing.T) {
|
||||||
// t.Setenv puts back whatever value was there after the test.
|
// t.Setenv puts back whatever value was there after the test.
|
||||||
t.Setenv("IRC_LISTEN_ADDR", "")
|
t.Setenv("IRC_LISTEN_ADDR", "")
|
||||||
|
|||||||
+7
-33
@@ -5,11 +5,9 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"database/sql"
|
"database/sql"
|
||||||
"embed"
|
"embed"
|
||||||
"errors"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/url"
|
|
||||||
"sort"
|
"sort"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -24,10 +22,6 @@ import (
|
|||||||
|
|
||||||
const minMigrationParts = 2
|
const minMigrationParts = 2
|
||||||
|
|
||||||
var errForeignKeysInDBURL = errors.New(
|
|
||||||
"DBURL must not set foreign_keys, which the server always turns on",
|
|
||||||
)
|
|
||||||
|
|
||||||
// SchemaFiles contains embedded SQL migration files.
|
// SchemaFiles contains embedded SQL migration files.
|
||||||
//
|
//
|
||||||
//go:embed schema/*.sql
|
//go:embed schema/*.sql
|
||||||
@@ -96,33 +90,6 @@ func (database *Database) connect(ctx context.Context) error {
|
|||||||
dbURL = config.DefaultDBURL
|
dbURL = config.DefaultDBURL
|
||||||
}
|
}
|
||||||
|
|
||||||
// SQLite keeps the foreign keys setting per connection. The driver
|
|
||||||
// runs each _pragma parameter on every connection it opens. So the
|
|
||||||
// one added below also covers the connection the pool opens after
|
|
||||||
// a cancelled query breaks the old one. A foreign_keys pragma in
|
|
||||||
// DBURL could undo it, because the driver sorts the pragmas.
|
|
||||||
_, query, hasQuery := strings.Cut(dbURL, "?")
|
|
||||||
|
|
||||||
urlParams, err := url.ParseQuery(query)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("parse DBURL: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, pragma := range urlParams["_pragma"] {
|
|
||||||
if strings.Contains(strings.ToLower(pragma), "foreign_keys") {
|
|
||||||
return fmt.Errorf(
|
|
||||||
"%w: _pragma=%s", errForeignKeysInDBURL, pragma,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
separator := "?"
|
|
||||||
if hasQuery {
|
|
||||||
separator = "&"
|
|
||||||
}
|
|
||||||
|
|
||||||
dbURL += separator + "_pragma=foreign_keys(1)"
|
|
||||||
|
|
||||||
database.log.Info(
|
database.log.Info(
|
||||||
"connecting to database", "url", dbURL,
|
"connecting to database", "url", dbURL,
|
||||||
)
|
)
|
||||||
@@ -142,6 +109,13 @@ func (database *Database) connect(ctx context.Context) error {
|
|||||||
database.conn = conn
|
database.conn = conn
|
||||||
database.log.Info("database connected")
|
database.log.Info("database connected")
|
||||||
|
|
||||||
|
_, err = database.conn.ExecContext(
|
||||||
|
ctx, "PRAGMA foreign_keys = ON",
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("enable foreign keys: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
return database.runMigrations(ctx)
|
return database.runMigrations(ctx)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,34 +1,19 @@
|
|||||||
package db_test
|
package db_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"net/url"
|
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
|
||||||
|
|
||||||
"go.uber.org/fx/fxtest"
|
"go.uber.org/fx/fxtest"
|
||||||
"sneak.berlin/go/neoirc/internal/config"
|
"sneak.berlin/go/neoirc/internal/config"
|
||||||
"sneak.berlin/go/neoirc/internal/db"
|
"sneak.berlin/go/neoirc/internal/db"
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
"sneak.berlin/go/neoirc/internal/globals"
|
"sneak.berlin/go/neoirc/internal/globals"
|
||||||
"sneak.berlin/go/neoirc/internal/logger"
|
"sneak.berlin/go/neoirc/internal/logger"
|
||||||
)
|
)
|
||||||
|
|
||||||
const wantBusyTimeoutMS = 5000
|
const wantBusyTimeoutMS = 5000
|
||||||
|
|
||||||
const (
|
|
||||||
// endlessQuery counts the rows of a recursive query that never
|
|
||||||
// stops, so it runs until its context ends.
|
|
||||||
endlessQuery = `WITH RECURSIVE n(x) AS
|
|
||||||
(SELECT 1 UNION ALL SELECT x + 1 FROM n)
|
|
||||||
SELECT COUNT(*) FROM n`
|
|
||||||
|
|
||||||
endlessQueryTimeout = 100 * time.Millisecond
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestDefaultDBURLSetsWALAndBusyTimeout opens a file database
|
// TestDefaultDBURLSetsWALAndBusyTimeout opens a file database
|
||||||
// with the default URL's parameters the way the server does,
|
// with the default URL's parameters the way the server does,
|
||||||
// and checks the journal mode and busy timeout it ends up with.
|
// and checks the journal mode and busy timeout it ends up with.
|
||||||
@@ -88,191 +73,3 @@ func TestDefaultDBURLSetsWALAndBusyTimeout(t *testing.T) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestForeignKeysOnAfterCancelledQuery cancels a query while it
|
|
||||||
// runs, which makes the pool close its only connection and open a
|
|
||||||
// new one. A TEMP table lasts only as long as its connection, so
|
|
||||||
// its absence shows the connection was replaced. The test then
|
|
||||||
// checks that the file database keeps its tables and that the new
|
|
||||||
// connection has foreign keys on.
|
|
||||||
func TestForeignKeysOnAfterCancelledQuery(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, defaultParams, _ := strings.Cut(config.DefaultDBURL, "?")
|
|
||||||
|
|
||||||
urlParams := map[string]string{
|
|
||||||
"default parameters": "?" + defaultParams,
|
|
||||||
"no parameters": "",
|
|
||||||
}
|
|
||||||
|
|
||||||
for name, params := range urlParams {
|
|
||||||
t.Run(name, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
dbURL := "file://" +
|
|
||||||
filepath.Join(t.TempDir(), "state.db") + params
|
|
||||||
|
|
||||||
database, err := startDatabase(t, dbURL)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = database.GetDB().ExecContext(
|
|
||||||
t.Context(), "CREATE TEMP TABLE first_connection (x)",
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(
|
|
||||||
t.Context(), endlessQueryTimeout,
|
|
||||||
)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
_, err = database.GetDB().ExecContext(ctx, endlessQuery)
|
|
||||||
if !errors.Is(err, context.DeadlineExceeded) {
|
|
||||||
t.Fatalf("endless query: err = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tempTables := queryInt(
|
|
||||||
t, database, "SELECT COUNT(*) FROM sqlite_temp_schema",
|
|
||||||
)
|
|
||||||
if tempTables != 0 {
|
|
||||||
t.Fatal("the pool kept its first connection")
|
|
||||||
}
|
|
||||||
|
|
||||||
migrations := queryInt(
|
|
||||||
t, database, "SELECT COUNT(*) FROM schema_migrations",
|
|
||||||
)
|
|
||||||
if migrations == 0 {
|
|
||||||
t.Error("schema_migrations is empty")
|
|
||||||
}
|
|
||||||
|
|
||||||
foreignKeys := queryInt(t, database, "PRAGMA foreign_keys")
|
|
||||||
if foreignKeys != 1 {
|
|
||||||
t.Errorf("foreign_keys = %d, want 1", foreignKeys)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewURLKeepsDataAfterCancelledQuery cancels a query on a test
|
|
||||||
// database while it runs, which makes the pool close its only
|
|
||||||
// connection and open a new one. A TEMP table lasts only as long as
|
|
||||||
// its connection, so its absence shows the connection was replaced.
|
|
||||||
// The database must still have its tables and rows.
|
|
||||||
func TestNewURLKeepsDataAfterCancelledQuery(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
database, err := startDatabase(t, dbtest.NewURL(t))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = database.GetOrCreateChannel(t.Context(), "#test")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = database.GetDB().ExecContext(
|
|
||||||
t.Context(), "CREATE TEMP TABLE first_connection (x)",
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(t.Context(), endlessQueryTimeout)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
_, err = database.GetDB().ExecContext(ctx, endlessQuery)
|
|
||||||
if !errors.Is(err, context.DeadlineExceeded) {
|
|
||||||
t.Fatalf("endless query: err = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tempTables := queryInt(
|
|
||||||
t, database, "SELECT COUNT(*) FROM sqlite_temp_schema",
|
|
||||||
)
|
|
||||||
if tempTables != 0 {
|
|
||||||
t.Fatal("the pool kept its first connection")
|
|
||||||
}
|
|
||||||
|
|
||||||
channels := queryInt(t, database, "SELECT COUNT(*) FROM channels")
|
|
||||||
if channels != 1 {
|
|
||||||
t.Errorf("channels = %d, want 1", channels)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDBURLSettingForeignKeysFailsStartup checks that the database
|
|
||||||
// refuses to start when DBURL sets foreign_keys itself, however it
|
|
||||||
// is spelled.
|
|
||||||
func TestDBURLSettingForeignKeysFailsStartup(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
pragmas := []string{
|
|
||||||
"foreign_keys(0)",
|
|
||||||
"foreign_keys(off)",
|
|
||||||
"foreign_keys=0",
|
|
||||||
"FOREIGN_KEYS(FALSE)",
|
|
||||||
" Foreign_Keys = 1",
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, pragma := range pragmas {
|
|
||||||
t.Run(pragma, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
dbURL := "file://" +
|
|
||||||
filepath.Join(t.TempDir(), "state.db") +
|
|
||||||
"?_pragma=" + url.QueryEscape(pragma)
|
|
||||||
|
|
||||||
_, err := startDatabase(t, dbURL)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("the database started")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(err.Error(), "DBURL") {
|
|
||||||
t.Errorf("error %q does not name DBURL", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// startDatabase starts a Database for dbURL the way the server does.
|
|
||||||
// It returns the error that stopped it from starting, if any.
|
|
||||||
func startDatabase(t *testing.T, dbURL string) (*db.Database, error) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
lifecycle := fxtest.NewLifecycle(t)
|
|
||||||
|
|
||||||
log, err := logger.New(lifecycle, logger.Params{
|
|
||||||
Globals: &globals.Globals{},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
database, err := db.New(lifecycle, db.Params{
|
|
||||||
Logger: log,
|
|
||||||
Config: &config.Config{DBURL: dbURL},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Cleanup(lifecycle.RequireStop)
|
|
||||||
|
|
||||||
return database, lifecycle.Start(t.Context())
|
|
||||||
}
|
|
||||||
|
|
||||||
// queryInt runs a query that returns a single number.
|
|
||||||
func queryInt(t *testing.T, database *db.Database, query string) int {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var result int
|
|
||||||
|
|
||||||
err := database.GetDB().QueryRowContext(t.Context(), query).Scan(&result)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return result
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -5,16 +5,21 @@ import (
|
|||||||
"database/sql"
|
"database/sql"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"testing"
|
"sync/atomic"
|
||||||
|
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// NewTestDatabase creates an in-memory database for testing.
|
//nolint:gochecknoglobals // test counter
|
||||||
func NewTestDatabase(tb testing.TB) (*Database, error) {
|
var testDBCounter atomic.Int64
|
||||||
tb.Helper()
|
|
||||||
|
|
||||||
dsn := dbtest.NewURL(tb) + "&_pragma=foreign_keys(1)"
|
// NewTestDatabase creates an in-memory database for testing.
|
||||||
|
func NewTestDatabase() (*Database, error) {
|
||||||
|
counter := testDBCounter.Add(1)
|
||||||
|
|
||||||
|
dsn := fmt.Sprintf(
|
||||||
|
"file:testdb%d?mode=memory"+
|
||||||
|
"&cache=shared&_pragma=foreign_keys(1)",
|
||||||
|
counter,
|
||||||
|
)
|
||||||
|
|
||||||
conn, err := sql.Open("sqlite", dsn)
|
conn, err := sql.Open("sqlite", dsn)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ import (
|
|||||||
func setupTestDB(t *testing.T) *db.Database {
|
func setupTestDB(t *testing.T) *db.Database {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
database, err := db.NewTestDatabase(t)
|
database, err := db.NewTestDatabase()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,39 +0,0 @@
|
|||||||
// Package dbtest gives each test a database of its own. Only tests
|
|
||||||
// may import it.
|
|
||||||
package dbtest
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/rand"
|
|
||||||
"database/sql"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
_ "modernc.org/sqlite" // registers the sqlite driver
|
|
||||||
)
|
|
||||||
|
|
||||||
// NewURL returns the URL of a new, empty in-memory database for one
|
|
||||||
// test. SQLite deletes an in-memory database when its last connection
|
|
||||||
// closes. A pool closes a connection when a query on it is cancelled
|
|
||||||
// while it runs. So this function holds a connection of its own open
|
|
||||||
// until the test ends.
|
|
||||||
func NewURL(tb testing.TB) string {
|
|
||||||
tb.Helper()
|
|
||||||
|
|
||||||
// A random name, so that no other test can share the database.
|
|
||||||
dbURL := "file:" + rand.Text() + "?mode=memory&cache=shared"
|
|
||||||
|
|
||||||
pool, err := sql.Open("sqlite", dbURL)
|
|
||||||
if err != nil {
|
|
||||||
tb.Fatalf("open test database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tb.Cleanup(func() { _ = pool.Close() })
|
|
||||||
|
|
||||||
conn, err := pool.Conn(tb.Context())
|
|
||||||
if err != nil {
|
|
||||||
tb.Fatalf("connect to test database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tb.Cleanup(func() { _ = conn.Close() })
|
|
||||||
|
|
||||||
return dbURL
|
|
||||||
}
|
|
||||||
@@ -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, "", "ikmnostl"},
|
||||||
"",
|
"",
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -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(
|
||||||
|
|||||||
+24
-449
File diff suppressed because it is too large
Load Diff
@@ -1,3 +1,4 @@
|
|||||||
|
//nolint:paralleltest // global viper, as in api_test.go
|
||||||
package handlers_test
|
package handlers_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -71,8 +72,6 @@ func numericBody(
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestUserhost(t *testing.T) {
|
func TestUserhost(t *testing.T) {
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tserver := newTestServer(t)
|
tserver := newTestServer(t)
|
||||||
|
|
||||||
token := tserver.createSession("alice")
|
token := tserver.createSession("alice")
|
||||||
@@ -110,8 +109,6 @@ func TestUserhost(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestVersionAdminInfoTime(t *testing.T) {
|
func TestVersionAdminInfoTime(t *testing.T) {
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tserver := newTestServer(t)
|
tserver := newTestServer(t)
|
||||||
|
|
||||||
token := tserver.createSession("frank")
|
token := tserver.createSession("frank")
|
||||||
@@ -150,8 +147,6 @@ func TestVersionAdminInfoTime(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestKill(t *testing.T) {
|
func TestKill(t *testing.T) {
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tserver := newTestServerWithOper(t)
|
tserver := newTestServerWithOper(t)
|
||||||
|
|
||||||
victimToken := tserver.createSession("victim")
|
victimToken := tserver.createSession("victim")
|
||||||
@@ -218,8 +213,6 @@ func TestKill(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestWallops(t *testing.T) {
|
func TestWallops(t *testing.T) {
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tserver := newTestServerWithOper(t)
|
tserver := newTestServerWithOper(t)
|
||||||
|
|
||||||
receiverToken := tserver.createSession("receiver")
|
receiverToken := tserver.createSession("receiver")
|
||||||
@@ -265,8 +258,6 @@ func TestWallops(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestUserMode(t *testing.T) {
|
func TestUserMode(t *testing.T) {
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
const (
|
const (
|
||||||
nick = "alice"
|
nick = "alice"
|
||||||
other = "other"
|
other = "other"
|
||||||
|
|||||||
@@ -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", "", "mnst",
|
||||||
)
|
)
|
||||||
c.sendNumeric(
|
c.sendNumeric(
|
||||||
irc.RplIsupport,
|
irc.RplIsupport,
|
||||||
|
|||||||
@@ -32,12 +32,8 @@ func (c *Conn) relayMessages(ctx context.Context) {
|
|||||||
// still signals waitCh.
|
// still signals waitCh.
|
||||||
waitCh := c.brk.Wait(c.sessionID)
|
waitCh := c.brk.Wait(c.sessionID)
|
||||||
|
|
||||||
// Drain any available messages. The drain ignores the
|
// Drain any available messages.
|
||||||
// cancel that comes when the connection ends, because a
|
delivered := c.drainQueue(ctx)
|
||||||
// query cancelled while it runs leaves the SQLite
|
|
||||||
// connection marked broken, and the pool closes it. The
|
|
||||||
// loop still stops on ctx.
|
|
||||||
delivered := c.drainQueue(context.WithoutCancel(ctx))
|
|
||||||
|
|
||||||
if delivered {
|
if delivered {
|
||||||
c.brk.Remove(c.sessionID, waitCh)
|
c.brk.Remove(c.sessionID, waitCh)
|
||||||
|
|||||||
@@ -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)
|
||||||
|
|
||||||
|
|||||||
@@ -3,15 +3,14 @@ package ircserver_test
|
|||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
"context"
|
"context"
|
||||||
|
"crypto/rand"
|
||||||
"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"
|
||||||
@@ -21,11 +20,9 @@ import (
|
|||||||
"sneak.berlin/go/neoirc/internal/broker"
|
"sneak.berlin/go/neoirc/internal/broker"
|
||||||
"sneak.berlin/go/neoirc/internal/config"
|
"sneak.berlin/go/neoirc/internal/config"
|
||||||
"sneak.berlin/go/neoirc/internal/db"
|
"sneak.berlin/go/neoirc/internal/db"
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
"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"
|
||||||
)
|
)
|
||||||
@@ -110,7 +107,14 @@ func newTestEnvWithResolver(
|
|||||||
) *testEnv {
|
) *testEnv {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
conn, err := sql.Open("sqlite", dbtest.NewURL(t))
|
// A random name, so that no other test environment, not
|
||||||
|
// even an earlier run of the same test, can share it.
|
||||||
|
dsn := fmt.Sprintf(
|
||||||
|
"file:%s?mode=memory&cache=shared",
|
||||||
|
rand.Text(),
|
||||||
|
)
|
||||||
|
|
||||||
|
conn, err := sql.Open("sqlite", dsn)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("open db: %v", err)
|
t.Fatalf("open db: %v", err)
|
||||||
}
|
}
|
||||||
@@ -140,6 +144,20 @@ func newTestEnvWithResolver(
|
|||||||
|
|
||||||
brk := broker.New()
|
brk := broker.New()
|
||||||
|
|
||||||
|
var listenConfig net.ListenConfig
|
||||||
|
|
||||||
|
listener, err := listenConfig.Listen(t.Context(), "tcp", "127.0.0.1:0")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("listen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
addr := listener.Addr().String()
|
||||||
|
|
||||||
|
err = listener.Close()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("close listener: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
log := slog.New(slog.NewTextHandler(
|
log := slog.New(slog.NewTextHandler(
|
||||||
os.Stderr,
|
os.Stderr,
|
||||||
&slog.HandlerOptions{Level: slog.LevelError}, //nolint:exhaustruct
|
&slog.HandlerOptions{Level: slog.LevelError}, //nolint:exhaustruct
|
||||||
@@ -149,9 +167,7 @@ func newTestEnvWithResolver(
|
|||||||
log, cfg, database, brk, interval, deadline, resolve,
|
log, cfg, database, brk, interval, deadline, resolve,
|
||||||
)
|
)
|
||||||
|
|
||||||
// Port 0 makes the system pick a free port. dial reads it
|
err = srv.Start(addr)
|
||||||
// back from the server's listener.
|
|
||||||
err = srv.Start("127.0.0.1:0")
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("start irc server: %v", err)
|
t.Fatalf("start irc server: %v", err)
|
||||||
}
|
}
|
||||||
@@ -489,22 +505,6 @@ func TestWelcomeContainsNick(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestMyInfoListsModes checks that RPL_MYINFO lists the user
|
|
||||||
// modes o and w, then the channel modes MODE accepts on the
|
|
||||||
// IRC listener. It compares the whole line, so a missing or
|
|
||||||
// extra mode fails it.
|
|
||||||
func TestMyInfoListsModes(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
env := newTestEnv(t)
|
|
||||||
lines := env.dial(t).register("carol")
|
|
||||||
|
|
||||||
want := ":test.irc 004 carol test.irc neoirc ow Himnostv"
|
|
||||||
if !slices.Contains(lines, want) {
|
|
||||||
t.Errorf("no line %q in %v", want, lines)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPingPong(t *testing.T) {
|
func TestPingPong(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -875,112 +875,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 +1144,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 +1156,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",
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -15,12 +15,6 @@ func NewTestSPAServer() *Server {
|
|||||||
return srv
|
return srv
|
||||||
}
|
}
|
||||||
|
|
||||||
// Listener returns the listener the start hook bound for the
|
|
||||||
// HTTP server.
|
|
||||||
func (srv *Server) Listener() net.Listener {
|
|
||||||
return srv.listener
|
|
||||||
}
|
|
||||||
|
|
||||||
// ServeUntilShutdown runs serveUntilShutdown, which serves the
|
// ServeUntilShutdown runs serveUntilShutdown, which serves the
|
||||||
// HTTP server on listener, and returns when it does.
|
// HTTP server on listener, and returns when it does.
|
||||||
func (srv *Server) ServeUntilShutdown(listener net.Listener) {
|
func (srv *Server) ServeUntilShutdown(listener net.Listener) {
|
||||||
|
|||||||
@@ -50,7 +50,6 @@ type Server struct {
|
|||||||
sentryEnabled bool
|
sentryEnabled bool
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
httpServer *http.Server
|
httpServer *http.Server
|
||||||
listener net.Listener
|
|
||||||
router *chi.Mux
|
router *chi.Mux
|
||||||
params Params
|
params Params
|
||||||
mw *middleware.Middleware
|
mw *middleware.Middleware
|
||||||
@@ -180,8 +179,6 @@ func (srv *Server) startHTTP(ctx context.Context) error {
|
|||||||
return fmt.Errorf("http listen: %w", err)
|
return fmt.Errorf("http listen: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
srv.listener = listener
|
|
||||||
|
|
||||||
srv.httpServer = &http.Server{ //nolint:exhaustruct // optional fields
|
srv.httpServer = &http.Server{ //nolint:exhaustruct // optional fields
|
||||||
Addr: listenAddr,
|
Addr: listenAddr,
|
||||||
ReadTimeout: httpReadTimeout,
|
ReadTimeout: httpReadTimeout,
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
package server_test
|
package server_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"crypto/rand"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
@@ -18,7 +19,6 @@ import (
|
|||||||
"sneak.berlin/go/neoirc/internal/broker"
|
"sneak.berlin/go/neoirc/internal/broker"
|
||||||
"sneak.berlin/go/neoirc/internal/config"
|
"sneak.berlin/go/neoirc/internal/config"
|
||||||
"sneak.berlin/go/neoirc/internal/db"
|
"sneak.berlin/go/neoirc/internal/db"
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
"sneak.berlin/go/neoirc/internal/globals"
|
"sneak.berlin/go/neoirc/internal/globals"
|
||||||
"sneak.berlin/go/neoirc/internal/handlers"
|
"sneak.berlin/go/neoirc/internal/handlers"
|
||||||
"sneak.berlin/go/neoirc/internal/healthcheck"
|
"sneak.berlin/go/neoirc/internal/healthcheck"
|
||||||
@@ -45,9 +45,10 @@ const (
|
|||||||
// for a long poll the HTTP server is serving to finish, and
|
// for a long poll the HTTP server is serving to finish, and
|
||||||
// that the poll gets its response.
|
// that the poll gets its response.
|
||||||
func TestStopWaitsForRequestInProgress(t *testing.T) {
|
func TestStopWaitsForRequestInProgress(t *testing.T) {
|
||||||
var srv *server.Server
|
port := freePort(t)
|
||||||
|
addr := net.JoinHostPort("127.0.0.1", strconv.Itoa(port))
|
||||||
|
|
||||||
app, brk, database := startApp(t, fx.Populate(&srv))
|
app, brk, database := startApp(t, port)
|
||||||
|
|
||||||
sessionID, _, token, err := database.CreateSession(
|
sessionID, _, token, err := database.CreateSession(
|
||||||
t.Context(), "poller", "poller", "", "",
|
t.Context(), "poller", "poller", "", "",
|
||||||
@@ -56,12 +57,9 @@ func TestStopWaitsForRequestInProgress(t *testing.T) {
|
|||||||
t.Fatalf("create session: %v", err)
|
t.Fatalf("create session: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
tcpAddr, ok := srv.Listener().Addr().(*net.TCPAddr)
|
waitUntil(t, "the HTTP server to listen", func() bool {
|
||||||
if !ok {
|
return canConnect(t, addr)
|
||||||
t.Fatalf("listener address %v is not TCP", srv.Listener().Addr())
|
})
|
||||||
}
|
|
||||||
|
|
||||||
addr := net.JoinHostPort("127.0.0.1", strconv.Itoa(tcpAddr.Port))
|
|
||||||
|
|
||||||
statuses := make(chan int, 1)
|
statuses := make(chan int, 1)
|
||||||
|
|
||||||
@@ -147,7 +145,7 @@ func TestStartFailsWhenHTTPPortIsTaken(t *testing.T) {
|
|||||||
func TestServeFailureStopsApp(t *testing.T) {
|
func TestServeFailureStopsApp(t *testing.T) {
|
||||||
var srv *server.Server
|
var srv *server.Server
|
||||||
|
|
||||||
app, _, _ := startApp(t, fx.Populate(&srv))
|
app, _, _ := startApp(t, freePort(t), fx.Populate(&srv))
|
||||||
|
|
||||||
shutdowns := app.Wait()
|
shutdowns := app.Wait()
|
||||||
|
|
||||||
@@ -170,7 +168,7 @@ func TestServeFailureStopsApp(t *testing.T) {
|
|||||||
func TestServeAfterStopDoesNotStopApp(t *testing.T) {
|
func TestServeAfterStopDoesNotStopApp(t *testing.T) {
|
||||||
var srv *server.Server
|
var srv *server.Server
|
||||||
|
|
||||||
app, _, _ := startApp(t, fx.Populate(&srv))
|
app, _, _ := startApp(t, freePort(t), fx.Populate(&srv))
|
||||||
|
|
||||||
shutdowns := app.Wait()
|
shutdowns := app.Wait()
|
||||||
|
|
||||||
@@ -188,15 +186,16 @@ func TestServeAfterStopDoesNotStopApp(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// startApp starts the app newApp builds, with the HTTP port
|
// startApp starts the app newApp builds, with the HTTP server
|
||||||
// set to 0, so the system gives the server a free port.
|
// listening on port.
|
||||||
func startApp(
|
func startApp(
|
||||||
t *testing.T,
|
t *testing.T,
|
||||||
|
port int,
|
||||||
options ...fx.Option,
|
options ...fx.Option,
|
||||||
) (*fxtest.App, *broker.Broker, *db.Database) {
|
) (*fxtest.App, *broker.Broker, *db.Database) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
app, brk, database := newApp(t, 0, options...)
|
app, brk, database := newApp(t, port, options...)
|
||||||
|
|
||||||
app.RequireStart()
|
app.RequireStart()
|
||||||
|
|
||||||
@@ -242,7 +241,10 @@ func newApp(
|
|||||||
stats.New,
|
stats.New,
|
||||||
),
|
),
|
||||||
fx.Decorate(func(cfg *config.Config) *config.Config {
|
fx.Decorate(func(cfg *config.Config) *config.Config {
|
||||||
cfg.DBURL = dbtest.NewURL(t)
|
// A random name, so that no other test can share it.
|
||||||
|
cfg.DBURL = fmt.Sprintf(
|
||||||
|
"file:%s?mode=memory&cache=shared", rand.Text(),
|
||||||
|
)
|
||||||
cfg.Port = port
|
cfg.Port = port
|
||||||
|
|
||||||
return cfg
|
return cfg
|
||||||
@@ -255,6 +257,21 @@ func newApp(
|
|||||||
return app, brk, database
|
return app, brk, database
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// freePort returns a TCP port that nothing was listening on a
|
||||||
|
// moment ago.
|
||||||
|
func freePort(t *testing.T) int {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
listener := closedListener(t)
|
||||||
|
|
||||||
|
tcpAddr, ok := listener.Addr().(*net.TCPAddr)
|
||||||
|
if !ok {
|
||||||
|
t.Fatalf("listener address %v is not TCP", listener.Addr())
|
||||||
|
}
|
||||||
|
|
||||||
|
return tcpAddr.Port
|
||||||
|
}
|
||||||
|
|
||||||
// closedListener returns a TCP listener that has already been
|
// closedListener returns a TCP listener that has already been
|
||||||
// closed, so that accepting a connection on it fails.
|
// closed, so that accepting a connection on it fails.
|
||||||
func closedListener(t *testing.T) net.Listener {
|
func closedListener(t *testing.T) net.Listener {
|
||||||
@@ -277,6 +294,22 @@ func closedListener(t *testing.T) net.Listener {
|
|||||||
return listener
|
return listener
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// canConnect reports whether addr accepts a TCP connection.
|
||||||
|
func canConnect(t *testing.T, addr string) bool {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var dialer net.Dialer
|
||||||
|
|
||||||
|
conn, err := dialer.DialContext(t.Context(), "tcp", addr)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
_ = conn.Close()
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
// waitUntil calls done every checkStep until it returns true,
|
// waitUntil calls done every checkStep until it returns true,
|
||||||
// and fails the test if it does not within testTimeout.
|
// and fails the test if it does not within testTimeout.
|
||||||
func waitUntil(t *testing.T, what string, done func() bool) {
|
func waitUntil(t *testing.T, what string, done func() bool) {
|
||||||
|
|||||||
@@ -1169,12 +1169,6 @@ func (s *Service) ApplyUserMode(
|
|||||||
return s.QueryUserMode(ctx, sessionID)
|
return s.QueryUserMode(ctx, sessionID)
|
||||||
}
|
}
|
||||||
|
|
||||||
// UserModes lists the user modes the server supports, as
|
|
||||||
// RPL_MYINFO sends them: o (server operator) and w
|
|
||||||
// (receives WALLOPS). parseUserModeString must accept the
|
|
||||||
// same letters.
|
|
||||||
const UserModes = "ow"
|
|
||||||
|
|
||||||
// parseUserModeString parses a user mode string such as
|
// parseUserModeString parses a user mode string such as
|
||||||
// "+w", "-o" or "+w-o" into the new value of each flag it
|
// "+w", "-o" or "+w-o" into the new value of each flag it
|
||||||
// names, or nil for a flag it does not name; a later letter
|
// names, or nil for a flag it does not name; a later letter
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ package service_test
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"crypto/rand"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
@@ -22,7 +23,6 @@ import (
|
|||||||
"sneak.berlin/go/neoirc/internal/broker"
|
"sneak.berlin/go/neoirc/internal/broker"
|
||||||
"sneak.berlin/go/neoirc/internal/config"
|
"sneak.berlin/go/neoirc/internal/config"
|
||||||
"sneak.berlin/go/neoirc/internal/db"
|
"sneak.berlin/go/neoirc/internal/db"
|
||||||
"sneak.berlin/go/neoirc/internal/dbtest"
|
|
||||||
"sneak.berlin/go/neoirc/internal/globals"
|
"sneak.berlin/go/neoirc/internal/globals"
|
||||||
"sneak.berlin/go/neoirc/internal/hashcash"
|
"sneak.berlin/go/neoirc/internal/hashcash"
|
||||||
"sneak.berlin/go/neoirc/internal/logger"
|
"sneak.berlin/go/neoirc/internal/logger"
|
||||||
@@ -46,7 +46,13 @@ type testEnv struct {
|
|||||||
func newTestEnv(t *testing.T) *testEnv {
|
func newTestEnv(t *testing.T) *testEnv {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
dbURL := dbtest.NewURL(t)
|
// A random name, so that no other test can share it, not
|
||||||
|
// even one that has finished but still holds its database
|
||||||
|
// open.
|
||||||
|
dbURL := fmt.Sprintf(
|
||||||
|
"file:%s?mode=memory&cache=shared",
|
||||||
|
rand.Text(),
|
||||||
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
database *db.Database
|
database *db.Database
|
||||||
|
|||||||
+82
-85
@@ -1,101 +1,98 @@
|
|||||||
# Message schemas
|
# Message Schemas
|
||||||
|
|
||||||
This directory holds JSON Schema files (draft 2020-12) for the messages that the
|
JSON Schema definitions (draft 2020-12) for the neoirc protocol. Messages use
|
||||||
neoirc HTTP API carries. `message.json` describes the fields that every message
|
**IRC command names and numeric reply codes** (RFC 1459/2812) encoded as JSON
|
||||||
can have. `commands/` has files for some commands. `numerics/` has files for
|
over HTTP.
|
||||||
some of the numeric replies. A numeric reply is a server reply named by a
|
|
||||||
three-digit number, such as `001`. `README.md` at the repository root documents
|
|
||||||
the protocol.
|
|
||||||
|
|
||||||
The server can also run an IRC listener for ordinary IRC clients. The IRC
|
## Envelope
|
||||||
listener sends plain IRC lines, which these files do not describe.
|
|
||||||
|
|
||||||
## Message fields
|
Every message is a JSON object with a `command` field. The format maps directly
|
||||||
|
to IRC wire format:
|
||||||
Every message is one JSON object, which `message.json` calls the envelope. These
|
|
||||||
are the fields it can have:
|
|
||||||
|
|
||||||
- `command`: the IRC command name, such as `PRIVMSG`, or the name of a numeric
|
|
||||||
reply, such as `RPL_WELCOME`. Always present.
|
|
||||||
- `code`: the number of a numeric reply, such as `1` for `RPL_WELCOME`. Absent
|
|
||||||
on other messages.
|
|
||||||
- `id`: the message's UUID, a unique ID that the server assigns.
|
|
||||||
- `from`: the sender's nick, or the server name on a numeric reply or a `PONG`.
|
|
||||||
- `to`: the target, such as a channel name starting with `#` or a nick.
|
|
||||||
- `params`: an array of strings with the message's other parameters, in order.
|
|
||||||
`KICK` events and many numeric replies have it. The HTTP API ignores `params`
|
|
||||||
sent by a client.
|
|
||||||
- `body`: an array of strings. It is never a bare string. In a `PRIVMSG` or
|
|
||||||
`NOTICE`, each string is one line of text.
|
|
||||||
- `ts`: the time the server stored the message. It is an RFC 3339 time in UTC,
|
|
||||||
such as `2026-10-27T12:00:00.123Z`.
|
|
||||||
- `meta`: an object of extra data, such as a hashcash stamp in `meta.hashcash`.
|
|
||||||
A hashcash stamp is a short string that takes a computer some work to make. A
|
|
||||||
`PRIVMSG` to a channel with mode `+H` needs one. The HTTP API relays the
|
|
||||||
`meta` of a `PRIVMSG` or `NOTICE` unchanged. It drops the `meta` of every
|
|
||||||
other command.
|
|
||||||
|
|
||||||
Here is one `PRIVMSG` as the IRC listener sends it and as the HTTP API sends it.
|
|
||||||
The JSON leaves out `id`, `ts` and `meta`:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
IRC: :alice!alice@* PRIVMSG #general :hello world
|
IRC: :nick PRIVMSG #channel :hello world
|
||||||
JSON: {"command": "PRIVMSG", "from": "alice", "to": "#general", "body": ["hello world"]}
|
JSON: {"command": "PRIVMSG", "from": "nick", "to": "#channel", "body": ["hello world"]}
|
||||||
|
|
||||||
|
IRC: :server 353 nick = #channel :user1 @op1 +voice1
|
||||||
|
JSON: {"command": "353", "to": "nick", "params": ["=", "#channel"], "body": ["user1 @op1 +voice1"]}
|
||||||
|
|
||||||
|
Multiline: {"command": "PRIVMSG", "to": "#ch", "body": ["line 1", "line 2"]}
|
||||||
|
Structured: {"command": "PUBKEY", "body": {"alg": "ed25519", "key": "base64..."}}
|
||||||
```
|
```
|
||||||
|
|
||||||
In the JSON, a numeric reply has its name in `command` and its number in `code`.
|
Common fields (see `message.json` for full schema):
|
||||||
This `353` reply lists the members of `#general`. The JSON again leaves out
|
|
||||||
`id`, `ts` and `meta`:
|
|
||||||
|
|
||||||
```
|
| Field | Type | Description |
|
||||||
{"command": "RPL_NAMREPLY", "code": 353, "from": "neoirc", "to": "alice",
|
| --------- | --------------- | ---------------------------------------------------- |
|
||||||
"params": ["=", "#general"], "body": ["@op1!op1@host1 alice!alice@host2"]}
|
| `id` | string (uuid) | Server-assigned message UUID |
|
||||||
```
|
| `command` | string | IRC command or 3-digit numeric code |
|
||||||
|
| `from` | string | Source nick or server name (IRC prefix) |
|
||||||
|
| `to` | string | Target: #channel or nick |
|
||||||
|
| `params` | string[] | Middle parameters (mainly for numerics) |
|
||||||
|
| `body` | array \| object | Structured body — never a raw string (see below) |
|
||||||
|
| `ts` | string | ISO 8601 timestamp (server-assigned, not in raw IRC) |
|
||||||
|
| `meta` | object | Extensible metadata (signatures, hashes, etc.) |
|
||||||
|
|
||||||
A `PRIVMSG` whose `body` has two strings is a two-line message:
|
**Structured bodies:** `body` is always an array of strings (for text) or an
|
||||||
|
object (for structured data like PUBKEY). Never a raw string. This enables:
|
||||||
|
|
||||||
```
|
- Multiline messages without escape sequences
|
||||||
{"command": "PRIVMSG", "to": "#general", "body": ["line one", "line two"]}
|
- Deterministic canonicalization via RFC 8785 JCS for signing
|
||||||
```
|
- Structured data where needed
|
||||||
|
|
||||||
## Files
|
## Commands
|
||||||
|
|
||||||
Most command files describe both the message a client sends and the message the
|
IRC commands used for client↔server and server↔server communication.
|
||||||
server sends. Their field descriptions say where the two differ. The examples in
|
|
||||||
the files leave out `id`, `ts` and `meta`.
|
|
||||||
|
|
||||||
Commands, in `commands/`:
|
| Command | File | RFC | Description |
|
||||||
|
| --------- | ----------------------- | ----------- | -------------------------- |
|
||||||
|
| `PRIVMSG` | `commands/PRIVMSG.json` | 1459 §4.4.1 | Message to channel or user |
|
||||||
|
| `NOTICE` | `commands/NOTICE.json` | 1459 §4.4.2 | Notice (no auto-reply) |
|
||||||
|
| `JOIN` | `commands/JOIN.json` | 1459 §4.2.1 | Join a channel |
|
||||||
|
| `PART` | `commands/PART.json` | 1459 §4.2.2 | Leave a channel |
|
||||||
|
| `QUIT` | `commands/QUIT.json` | 1459 §4.1.6 | User disconnected |
|
||||||
|
| `NICK` | `commands/NICK.json` | 1459 §4.1.2 | Change nickname |
|
||||||
|
| `TOPIC` | `commands/TOPIC.json` | 1459 §4.2.4 | Get/set channel topic |
|
||||||
|
| `MODE` | `commands/MODE.json` | 1459 §4.2.3 | Set channel/user modes |
|
||||||
|
| `KICK` | `commands/KICK.json` | 1459 §4.2.8 | Kick user from channel |
|
||||||
|
| `PING` | `commands/PING.json` | 1459 §4.6.2 | Keepalive |
|
||||||
|
| `PONG` | `commands/PONG.json` | 1459 §4.6.3 | Keepalive response |
|
||||||
|
| `PUBKEY` | `commands/PUBKEY.json` | (extension) | Announce/relay signing key |
|
||||||
|
|
||||||
- `PRIVMSG.json`: a message to a channel or a user.
|
## Numeric Replies
|
||||||
- `NOTICE.json`: a notice, which is a message that a client must not answer
|
|
||||||
automatically.
|
|
||||||
- `JOIN.json`: joining a channel.
|
|
||||||
- `PART.json`: leaving a channel.
|
|
||||||
- `QUIT.json`: leaving the server.
|
|
||||||
- `NICK.json`: changing nick.
|
|
||||||
- `TOPIC.json`: setting a channel's topic.
|
|
||||||
- `MODE.json`: querying or changing a channel's modes or the user's own modes.
|
|
||||||
- `KICK.json`: a channel operator removing a user from a channel.
|
|
||||||
- `PING.json`: a check that the server still answers.
|
|
||||||
- `PONG.json`: the answer to a `PING`, which is the HTTP response to it.
|
|
||||||
|
|
||||||
Numeric replies, in `numerics/`:
|
Three-digit codes for server responses, per IRC convention.
|
||||||
|
|
||||||
- `001.json`: `RPL_WELCOME`, which welcomes the user.
|
### Success / Informational (0xx–3xx)
|
||||||
- `002.json`: `RPL_YOURHOST`, the server's name and version.
|
|
||||||
- `003.json`: `RPL_CREATED`, the date the server last started.
|
| Code | Name | File | Description |
|
||||||
- `004.json`: `RPL_MYINFO`, the server's name, its version and its lists of
|
| ----- | -------------- | ------------------- | ------------------------------ |
|
||||||
modes.
|
| `001` | RPL_WELCOME | `numerics/001.json` | Welcome after session creation |
|
||||||
- `322.json`: `RPL_LIST`, one channel in the answer to `LIST`.
|
| `002` | RPL_YOURHOST | `numerics/002.json` | Server host info |
|
||||||
- `323.json`: `RPL_LISTEND`, the end of the answer to `LIST`.
|
| `003` | RPL_CREATED | `numerics/003.json` | Server creation date |
|
||||||
- `332.json`: `RPL_TOPIC`, a channel's topic.
|
| `004` | RPL_MYINFO | `numerics/004.json` | Server info and modes |
|
||||||
- `353.json`: `RPL_NAMREPLY`, a channel's members.
|
| `322` | RPL_LIST | `numerics/322.json` | Channel list entry |
|
||||||
- `366.json`: `RPL_ENDOFNAMES`, the end of the member list.
|
| `323` | RPL_LISTEND | `numerics/323.json` | End of channel list |
|
||||||
- `372.json`: `RPL_MOTD`, one line of the message of the day.
|
| `332` | RPL_TOPIC | `numerics/332.json` | Channel topic |
|
||||||
- `375.json`: `RPL_MOTDSTART`, the start of the message of the day.
|
| `353` | RPL_NAMREPLY | `numerics/353.json` | Channel member list |
|
||||||
- `376.json`: `RPL_ENDOFMOTD`, the end of the message of the day.
|
| `366` | RPL_ENDOFNAMES | `numerics/366.json` | End of NAMES list |
|
||||||
- `401.json`: `ERR_NOSUCHNICK`, the nick does not exist.
|
| `372` | RPL_MOTD | `numerics/372.json` | MOTD line |
|
||||||
- `403.json`: `ERR_NOSUCHCHANNEL`, the channel does not exist.
|
| `375` | RPL_MOTDSTART | `numerics/375.json` | Start of MOTD |
|
||||||
- `433.json`: `ERR_NICKNAMEINUSE`, the nick is taken.
|
| `376` | RPL_ENDOFMOTD | `numerics/376.json` | End of MOTD |
|
||||||
- `442.json`: `ERR_NOTONCHANNEL`, the user is not on that channel.
|
|
||||||
- `482.json`: `ERR_CHANOPRIVSNEEDED`, the user is not a channel operator.
|
### Errors (4xx)
|
||||||
|
|
||||||
|
| Code | Name | File | Description |
|
||||||
|
| ----- | -------------------- | ------------------- | ----------------------- |
|
||||||
|
| `401` | ERR_NOSUCHNICK | `numerics/401.json` | No such nick/channel |
|
||||||
|
| `403` | ERR_NOSUCHCHANNEL | `numerics/403.json` | No such channel |
|
||||||
|
| `433` | ERR_NICKNAMEINUSE | `numerics/433.json` | Nickname already in use |
|
||||||
|
| `442` | ERR_NOTONCHANNEL | `numerics/442.json` | Not on that channel |
|
||||||
|
| `482` | ERR_CHANOPRIVSNEEDED | `numerics/482.json` | Not channel operator |
|
||||||
|
|
||||||
|
## Federation (S2S)
|
||||||
|
|
||||||
|
Server-to-server messages use the same command format. Federated servers relay
|
||||||
|
messages with an additional `origin` field in `meta` to track the source server.
|
||||||
|
The PING/PONG commands serve as inter-server keepalives. State sync after link
|
||||||
|
establishment uses a burst of JOIN, NICK, TOPIC, and MODE commands.
|
||||||
|
|||||||
@@ -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"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
+57
-129
@@ -7,11 +7,6 @@ const RECONNECT_DELAY = 3000;
|
|||||||
const MEMBER_REFRESH_INTERVAL = 10000;
|
const MEMBER_REFRESH_INTERVAL = 10000;
|
||||||
const ACTION_PREFIX = "\x01ACTION ";
|
const ACTION_PREFIX = "\x01ACTION ";
|
||||||
const ACTION_SUFFIX = "\x01";
|
const ACTION_SUFFIX = "\x01";
|
||||||
// SERVER_TAB is the Server tab's name, under which its messages and
|
|
||||||
// unread count are stored. No nick or channel name can contain *, so a
|
|
||||||
// user with the nick Server gets a direct-message tab of its own. The
|
|
||||||
// tab bar labels this tab Server.
|
|
||||||
const SERVER_TAB = "*server*";
|
|
||||||
|
|
||||||
// Hashcash proof-of-work helpers using Web Crypto API.
|
// Hashcash proof-of-work helpers using Web Crypto API.
|
||||||
|
|
||||||
@@ -275,9 +270,9 @@ function UserList({ members, onNickClick }) {
|
|||||||
function App() {
|
function App() {
|
||||||
const [loggedIn, setLoggedIn] = useState(false);
|
const [loggedIn, setLoggedIn] = useState(false);
|
||||||
const [nick, setNick] = useState("");
|
const [nick, setNick] = useState("");
|
||||||
const [tabs, setTabs] = useState([{ type: "server", name: SERVER_TAB }]);
|
const [tabs, setTabs] = useState([{ type: "server", name: "Server" }]);
|
||||||
const [activeTab, setActiveTab] = useState(0);
|
const [activeTab, setActiveTab] = useState(0);
|
||||||
const [messages, setMessages] = useState({ [SERVER_TAB]: [] });
|
const [messages, setMessages] = useState({ Server: [] });
|
||||||
const [members, setMembers] = useState({});
|
const [members, setMembers] = useState({});
|
||||||
const [topics, setTopics] = useState({});
|
const [topics, setTopics] = useState({});
|
||||||
const [unread, setUnread] = useState({});
|
const [unread, setUnread] = useState({});
|
||||||
@@ -360,26 +355,6 @@ function App() {
|
|||||||
.catch(() => {});
|
.catch(() => {});
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
// removeChannelTab closes a channel's tab. The tab the user was
|
|
||||||
// reading stays active, found by its name; when it was the closed tab,
|
|
||||||
// the Server tab shows.
|
|
||||||
const removeChannelTab = useCallback((name) => {
|
|
||||||
setTabs((prev) => {
|
|
||||||
const remaining = prev.filter(
|
|
||||||
(t) => !(t.type === "channel" && t.name === name),
|
|
||||||
);
|
|
||||||
// Preact runs this update at once, on the newest active tab.
|
|
||||||
setActiveTab((active) => {
|
|
||||||
const reading = prev[active]?.name;
|
|
||||||
const idx = remaining.findIndex((t) => t.name === reading);
|
|
||||||
|
|
||||||
return idx >= 0 ? idx : 0;
|
|
||||||
});
|
|
||||||
|
|
||||||
return remaining;
|
|
||||||
});
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
const processMessage = useCallback(
|
const processMessage = useCallback(
|
||||||
(msg) => {
|
(msg) => {
|
||||||
const body = Array.isArray(msg.body) ? msg.body.join("\n") : "";
|
const body = Array.isArray(msg.body) ? msg.body.join("\n") : "";
|
||||||
@@ -449,13 +424,6 @@ function App() {
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case "PART": {
|
case "PART": {
|
||||||
// The user's own PART, sent from this client or another,
|
|
||||||
// closes the tab and adds no message or unread count.
|
|
||||||
if (msg.from === nickRef.current) {
|
|
||||||
removeChannelTab(msg.to);
|
|
||||||
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
const reason = body ? " (" + body + ")" : "";
|
const reason = body ? " (" + body + ")" : "";
|
||||||
const text = `${msg.from} has parted ${msg.to}${reason}`;
|
const text = `${msg.from} has parted ${msg.to}${reason}`;
|
||||||
if (msg.to) addMessage(msg.to, { ...base, text, system: true });
|
if (msg.to) addMessage(msg.to, { ...base, text, system: true });
|
||||||
@@ -463,29 +431,6 @@ function App() {
|
|||||||
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case "KICK": {
|
|
||||||
// The kicked nick is in params; the body is the reason.
|
|
||||||
const kicked = Array.isArray(msg.params) ? msg.params[0] : "";
|
|
||||||
const reason = body ? " (" + body + ")" : "";
|
|
||||||
const text = `${kicked} was kicked from ${msg.to} by ${msg.from}${reason}`;
|
|
||||||
if (msg.to) addMessage(msg.to, { ...base, text, system: true });
|
|
||||||
if (kicked === nickRef.current) {
|
|
||||||
// The channel's tab closes, so the Server tab gets the line
|
|
||||||
// too. It needs an id of its own: addMessage drops a message
|
|
||||||
// whose id it has already seen.
|
|
||||||
addMessage(SERVER_TAB, {
|
|
||||||
...base,
|
|
||||||
id: msg.id + "-server",
|
|
||||||
text,
|
|
||||||
system: true,
|
|
||||||
});
|
|
||||||
removeChannelTab(msg.to);
|
|
||||||
} else if (msg.to && msg.to.startsWith("#")) {
|
|
||||||
refreshMembers(msg.to);
|
|
||||||
}
|
|
||||||
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
case "QUIT": {
|
case "QUIT": {
|
||||||
const reason = body ? " (" + body + ")" : "";
|
const reason = body ? " (" + body + ")" : "";
|
||||||
const text = `${msg.from} has quit${reason}`;
|
const text = `${msg.from} has quit${reason}`;
|
||||||
@@ -573,7 +518,7 @@ function App() {
|
|||||||
const chName = msg.params[0];
|
const chName = msg.params[0];
|
||||||
const count = msg.params[1];
|
const count = msg.params[1];
|
||||||
const chTopic = body || "";
|
const chTopic = body || "";
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: `${chName} (${count} users): ${chTopic.trim()}`,
|
text: `${chName} (${count} users): ${chTopic.trim()}`,
|
||||||
system: true,
|
system: true,
|
||||||
@@ -583,7 +528,7 @@ function App() {
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case 323:
|
case 323:
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: body || "End of channel list",
|
text: body || "End of channel list",
|
||||||
system: true,
|
system: true,
|
||||||
@@ -596,7 +541,7 @@ function App() {
|
|||||||
const whoCh = msg.params[0];
|
const whoCh = msg.params[0];
|
||||||
const whoNick = msg.params[4];
|
const whoNick = msg.params[4];
|
||||||
const whoFlags = msg.params.length > 5 ? msg.params[5] : "";
|
const whoFlags = msg.params.length > 5 ? msg.params[5] : "";
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: `${whoCh} ${whoNick} ${whoFlags}`,
|
text: `${whoCh} ${whoNick} ${whoFlags}`,
|
||||||
system: true,
|
system: true,
|
||||||
@@ -606,7 +551,7 @@ function App() {
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case 315:
|
case 315:
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: body || "End of /WHO list",
|
text: body || "End of /WHO list",
|
||||||
system: true,
|
system: true,
|
||||||
@@ -617,7 +562,7 @@ function App() {
|
|||||||
// RPL_WHOISUSER — params nick, user, host, *; body realname.
|
// RPL_WHOISUSER — params nick, user, host, *; body realname.
|
||||||
if (Array.isArray(msg.params) && msg.params.length >= 3) {
|
if (Array.isArray(msg.params) && msg.params.length >= 3) {
|
||||||
const [wiNick, wiUser, wiHost] = msg.params;
|
const [wiNick, wiUser, wiHost] = msg.params;
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: `${wiNick} is ${wiUser}@${wiHost} (${body})`,
|
text: `${wiNick} is ${wiUser}@${wiHost} (${body})`,
|
||||||
system: true,
|
system: true,
|
||||||
@@ -631,7 +576,7 @@ function App() {
|
|||||||
if (Array.isArray(msg.params) && msg.params.length >= 2) {
|
if (Array.isArray(msg.params) && msg.params.length >= 2) {
|
||||||
const wiNick = msg.params[0];
|
const wiNick = msg.params[0];
|
||||||
const wiServer = msg.params[1];
|
const wiServer = msg.params[1];
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: `${wiNick} on ${wiServer}`,
|
text: `${wiNick} on ${wiServer}`,
|
||||||
system: true,
|
system: true,
|
||||||
@@ -643,7 +588,7 @@ function App() {
|
|||||||
case 313: {
|
case 313: {
|
||||||
// RPL_WHOISOPERATOR — nick; body "is an IRC operator".
|
// RPL_WHOISOPERATOR — nick; body "is an IRC operator".
|
||||||
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: `${msg.params[0]} ${body}`,
|
text: `${msg.params[0]} ${body}`,
|
||||||
system: true,
|
system: true,
|
||||||
@@ -657,7 +602,7 @@ function App() {
|
|||||||
if (Array.isArray(msg.params) && msg.params.length >= 3) {
|
if (Array.isArray(msg.params) && msg.params.length >= 3) {
|
||||||
const [wiNick, idle, signon] = msg.params;
|
const [wiNick, idle, signon] = msg.params;
|
||||||
const signedOn = new Date(Number(signon) * 1000).toLocaleString();
|
const signedOn = new Date(Number(signon) * 1000).toLocaleString();
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: `${wiNick} has been idle ${idle}s, signed on ${signedOn}`,
|
text: `${wiNick} has been idle ${idle}s, signed on ${signedOn}`,
|
||||||
system: true,
|
system: true,
|
||||||
@@ -670,7 +615,7 @@ function App() {
|
|||||||
// RPL_WHOISCHANNELS — nick, channels.
|
// RPL_WHOISCHANNELS — nick, channels.
|
||||||
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
if (Array.isArray(msg.params) && msg.params.length >= 1) {
|
||||||
const wiNick = msg.params[0];
|
const wiNick = msg.params[0];
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: `${wiNick} is on: ${body}`,
|
text: `${wiNick} is on: ${body}`,
|
||||||
system: true,
|
system: true,
|
||||||
@@ -680,7 +625,7 @@ function App() {
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case 318:
|
case 318:
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: body || "End of /WHOIS list",
|
text: body || "End of /WHOIS list",
|
||||||
system: true,
|
system: true,
|
||||||
@@ -690,7 +635,7 @@ function App() {
|
|||||||
case 324: {
|
case 324: {
|
||||||
// RPL_CHANNELMODEIS — channel, mode string.
|
// RPL_CHANNELMODEIS — channel, mode string.
|
||||||
if (Array.isArray(msg.params) && msg.params.length >= 2) {
|
if (Array.isArray(msg.params) && msg.params.length >= 2) {
|
||||||
addMessage(SERVER_TAB, {
|
addMessage("Server", {
|
||||||
...base,
|
...base,
|
||||||
text: `${msg.params[0]} modes: ${msg.params[1]}`,
|
text: `${msg.params[0]} modes: ${msg.params[1]}`,
|
||||||
system: true,
|
system: true,
|
||||||
@@ -702,16 +647,16 @@ function App() {
|
|||||||
case 375:
|
case 375:
|
||||||
case 372:
|
case 372:
|
||||||
case 376:
|
case 376:
|
||||||
addMessage(SERVER_TAB, { ...base, text: body, system: true });
|
addMessage("Server", { ...base, text: body, system: true });
|
||||||
|
|
||||||
break;
|
break;
|
||||||
default:
|
default:
|
||||||
if (body) {
|
if (body) {
|
||||||
addMessage(SERVER_TAB, { ...base, text: body, system: true });
|
addMessage("Server", { ...base, text: body, system: true });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
[addMessage, refreshMembers, removeChannelTab],
|
[addMessage, refreshMembers],
|
||||||
);
|
);
|
||||||
|
|
||||||
// Long-poll loop.
|
// Long-poll loop.
|
||||||
@@ -833,7 +778,7 @@ function App() {
|
|||||||
);
|
);
|
||||||
setNick(userNick);
|
setNick(userNick);
|
||||||
setLoggedIn(true);
|
setLoggedIn(true);
|
||||||
addSystemMessage(SERVER_TAB, `Connected as ${userNick}`);
|
addSystemMessage("Server", `Connected as ${userNick}`);
|
||||||
|
|
||||||
if (isResumed) {
|
if (isResumed) {
|
||||||
// Request MOTD on resumed sessions (new sessions
|
// Request MOTD on resumed sessions (new sessions
|
||||||
@@ -857,11 +802,10 @@ function App() {
|
|||||||
// Fresh session — join any previously saved channels.
|
// Fresh session — join any previously saved channels.
|
||||||
for (const ch of saved) {
|
for (const ch of saved) {
|
||||||
try {
|
try {
|
||||||
const res = await api("/messages", {
|
await api("/messages", {
|
||||||
method: "POST",
|
method: "POST",
|
||||||
body: JSON.stringify({ command: "JOIN", to: ch }),
|
body: JSON.stringify({ command: "JOIN", to: ch }),
|
||||||
});
|
});
|
||||||
if (res?.status !== "joined") continue;
|
|
||||||
setTabs((prev) => {
|
setTabs((prev) => {
|
||||||
if (prev.find((t) => t.type === "channel" && t.name === ch))
|
if (prev.find((t) => t.type === "channel" && t.name === ch))
|
||||||
return prev;
|
return prev;
|
||||||
@@ -881,30 +825,18 @@ function App() {
|
|||||||
name = name.trim();
|
name = name.trim();
|
||||||
if (!name.startsWith("#")) name = "#" + name;
|
if (!name.startsWith("#")) name = "#" + name;
|
||||||
try {
|
try {
|
||||||
const res = await api("/messages", {
|
await api("/messages", {
|
||||||
method: "POST",
|
method: "POST",
|
||||||
body: JSON.stringify({ command: "JOIN", to: name }),
|
body: JSON.stringify({ command: "JOIN", to: name }),
|
||||||
});
|
});
|
||||||
// A refused join opens no tab. The error numeric that the
|
|
||||||
// server sends to the message queue tells the user why.
|
|
||||||
if (res?.status !== "joined") return;
|
|
||||||
// Show the channel's tab. Preact runs this update at once on the
|
|
||||||
// newest tab list, so the tab is found there by name: the user's
|
|
||||||
// own JOIN event may already have added it, and other tabs may
|
|
||||||
// have closed.
|
|
||||||
setTabs((prev) => {
|
setTabs((prev) => {
|
||||||
const idx = prev.findIndex(
|
if (prev.find((t) => t.type === "channel" && t.name === name))
|
||||||
(t) => t.type === "channel" && t.name === name,
|
|
||||||
);
|
|
||||||
if (idx >= 0) {
|
|
||||||
setActiveTab(idx);
|
|
||||||
|
|
||||||
return prev;
|
return prev;
|
||||||
}
|
|
||||||
setActiveTab(prev.length);
|
|
||||||
|
|
||||||
return [...prev, { type: "channel", name }];
|
return [...prev, { type: "channel", name }];
|
||||||
});
|
});
|
||||||
|
const newIdx = tabsRef.current.length;
|
||||||
|
setActiveTab(newIdx);
|
||||||
try {
|
try {
|
||||||
const hist = await api(
|
const hist = await api(
|
||||||
`/history?target=${encodeURIComponent(name)}&limit=50`,
|
`/history?target=${encodeURIComponent(name)}&limit=50`,
|
||||||
@@ -917,7 +849,7 @@ function App() {
|
|||||||
}
|
}
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`Failed to join ${name}: ${err.data?.error || "error"}`,
|
`Failed to join ${name}: ${err.data?.error || "error"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -933,7 +865,10 @@ function App() {
|
|||||||
} catch (e) {
|
} catch (e) {
|
||||||
// Ignore.
|
// Ignore.
|
||||||
}
|
}
|
||||||
removeChannelTab(name);
|
setTabs((prev) =>
|
||||||
|
prev.filter((t) => !(t.type === "channel" && t.name === name)),
|
||||||
|
);
|
||||||
|
setActiveTab(0);
|
||||||
};
|
};
|
||||||
|
|
||||||
const closeTab = (idx) => {
|
const closeTab = (idx) => {
|
||||||
@@ -948,23 +883,16 @@ function App() {
|
|||||||
|
|
||||||
const openDM = (targetNick) => {
|
const openDM = (targetNick) => {
|
||||||
if (targetNick === nickRef.current) return;
|
if (targetNick === nickRef.current) return;
|
||||||
// Show the direct-message tab. Preact runs this update at once on
|
|
||||||
// the newest tab list, so the tab is found there by name: the
|
|
||||||
// server's copy of the user's message may already have added it,
|
|
||||||
// and other tabs may have opened or closed.
|
|
||||||
setTabs((prev) => {
|
setTabs((prev) => {
|
||||||
const idx = prev.findIndex(
|
if (prev.find((t) => t.type === "dm" && t.name === targetNick))
|
||||||
(t) => t.type === "dm" && t.name === targetNick,
|
|
||||||
);
|
|
||||||
if (idx >= 0) {
|
|
||||||
setActiveTab(idx);
|
|
||||||
|
|
||||||
return prev;
|
return prev;
|
||||||
}
|
|
||||||
setActiveTab(prev.length);
|
|
||||||
|
|
||||||
return [...prev, { type: "dm", name: targetNick }];
|
return [...prev, { type: "dm", name: targetNick }];
|
||||||
});
|
});
|
||||||
|
const idx = tabs.findIndex(
|
||||||
|
(t) => t.type === "dm" && t.name === targetNick,
|
||||||
|
);
|
||||||
|
setActiveTab(idx >= 0 ? idx : tabs.length);
|
||||||
};
|
};
|
||||||
|
|
||||||
const handleCommand = async (text) => {
|
const handleCommand = async (text) => {
|
||||||
@@ -975,7 +903,7 @@ function App() {
|
|||||||
switch (cmd) {
|
switch (cmd) {
|
||||||
case "/join": {
|
case "/join": {
|
||||||
if (parts[1]) joinChannel(parts[1]);
|
if (parts[1]) joinChannel(parts[1]);
|
||||||
else addSystemMessage(SERVER_TAB, "Usage: /join #channel");
|
else addSystemMessage("Server", "Usage: /join #channel");
|
||||||
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -984,7 +912,7 @@ function App() {
|
|||||||
const reason = parts.slice(1).join(" ") || undefined;
|
const reason = parts.slice(1).join(" ") || undefined;
|
||||||
partChannel(tab.name, reason);
|
partChannel(tab.name, reason);
|
||||||
} else {
|
} else {
|
||||||
addSystemMessage(SERVER_TAB, "You are not in a channel");
|
addSystemMessage("Server", "You are not in a channel");
|
||||||
}
|
}
|
||||||
|
|
||||||
break;
|
break;
|
||||||
@@ -1005,19 +933,19 @@ function App() {
|
|||||||
openDM(target);
|
openDM(target);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`Message failed: ${err.data?.error || "error"}`,
|
`Message failed: ${err.data?.error || "error"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
addSystemMessage(SERVER_TAB, "Usage: /msg <nick> <message>");
|
addSystemMessage("Server", "Usage: /msg <nick> <message>");
|
||||||
}
|
}
|
||||||
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case "/me": {
|
case "/me": {
|
||||||
if (tab.type === "server") {
|
if (tab.type === "server") {
|
||||||
addSystemMessage(SERVER_TAB, "Cannot use /me in server window");
|
addSystemMessage("Server", "Cannot use /me in server window");
|
||||||
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -1039,7 +967,7 @@ function App() {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
addSystemMessage(SERVER_TAB, "Usage: /me <action>");
|
addSystemMessage("Server", "Usage: /me <action>");
|
||||||
}
|
}
|
||||||
|
|
||||||
break;
|
break;
|
||||||
@@ -1053,19 +981,19 @@ function App() {
|
|||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`Nick change failed: ${err.data?.error || "error"}`,
|
`Nick change failed: ${err.data?.error || "error"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
addSystemMessage(SERVER_TAB, "Usage: /nick <newnick>");
|
addSystemMessage("Server", "Usage: /nick <newnick>");
|
||||||
}
|
}
|
||||||
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case "/topic": {
|
case "/topic": {
|
||||||
if (tab.type !== "channel") {
|
if (tab.type !== "channel") {
|
||||||
addSystemMessage(SERVER_TAB, "You are not in a channel");
|
addSystemMessage("Server", "You are not in a channel");
|
||||||
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -1082,13 +1010,13 @@ function App() {
|
|||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`Topic change failed: ${err.data?.error || "error"}`,
|
`Topic change failed: ${err.data?.error || "error"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`Current topic for ${tab.name}: ${topics[tab.name] || "(none)"}`,
|
`Current topic for ${tab.name}: ${topics[tab.name] || "(none)"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -1097,7 +1025,7 @@ function App() {
|
|||||||
}
|
}
|
||||||
case "/mode": {
|
case "/mode": {
|
||||||
if (tab.type !== "channel") {
|
if (tab.type !== "channel") {
|
||||||
addSystemMessage(SERVER_TAB, "You are not in a channel");
|
addSystemMessage("Server", "You are not in a channel");
|
||||||
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -1115,7 +1043,7 @@ function App() {
|
|||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`MODE failed: ${err.data?.error || "error"}`,
|
`MODE failed: ${err.data?.error || "error"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -1146,7 +1074,7 @@ function App() {
|
|||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`Failed to request MOTD: ${err.data?.error || "error"}`,
|
`Failed to request MOTD: ${err.data?.error || "error"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -1170,13 +1098,13 @@ function App() {
|
|||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`Message failed: ${err.data?.error || "error"}`,
|
`Message failed: ${err.data?.error || "error"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
addSystemMessage(SERVER_TAB, "Usage: /query <nick> [message]");
|
addSystemMessage("Server", "Usage: /query <nick> [message]");
|
||||||
}
|
}
|
||||||
|
|
||||||
break;
|
break;
|
||||||
@@ -1189,7 +1117,7 @@ function App() {
|
|||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`Failed to list channels: ${err.data?.error || "error"}`,
|
`Failed to list channels: ${err.data?.error || "error"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -1206,12 +1134,12 @@ function App() {
|
|||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`WHO failed: ${err.data?.error || "error"}`,
|
`WHO failed: ${err.data?.error || "error"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
addSystemMessage(SERVER_TAB, "Usage: /who #channel");
|
addSystemMessage("Server", "Usage: /who #channel");
|
||||||
}
|
}
|
||||||
|
|
||||||
break;
|
break;
|
||||||
@@ -1225,12 +1153,12 @@ function App() {
|
|||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
`WHOIS failed: ${err.data?.error || "error"}`,
|
`WHOIS failed: ${err.data?.error || "error"}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
addSystemMessage(SERVER_TAB, "Usage: /whois <nick>");
|
addSystemMessage("Server", "Usage: /whois <nick>");
|
||||||
}
|
}
|
||||||
|
|
||||||
break;
|
break;
|
||||||
@@ -1261,13 +1189,13 @@ function App() {
|
|||||||
" /help — Show this help",
|
" /help — Show this help",
|
||||||
];
|
];
|
||||||
for (const line of helpLines) {
|
for (const line of helpLines) {
|
||||||
addSystemMessage(SERVER_TAB, line);
|
addSystemMessage("Server", line);
|
||||||
}
|
}
|
||||||
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
default:
|
default:
|
||||||
addSystemMessage(SERVER_TAB, `Unknown command: ${cmd}`);
|
addSystemMessage("Server", `Unknown command: ${cmd}`);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -1296,7 +1224,7 @@ function App() {
|
|||||||
|
|
||||||
if (tab.type === "server") {
|
if (tab.type === "server") {
|
||||||
addSystemMessage(
|
addSystemMessage(
|
||||||
SERVER_TAB,
|
"Server",
|
||||||
"Cannot send messages to the server window. Use /join #channel first.",
|
"Cannot send messages to the server window. Use /join #channel first.",
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -1367,7 +1295,7 @@ function App() {
|
|||||||
key={tab.name}
|
key={tab.name}
|
||||||
>
|
>
|
||||||
<span class="tab-label">
|
<span class="tab-label">
|
||||||
{tab.type === "server" ? "Server" : tab.name}
|
{tab.type === "dm" ? tab.name : tab.name}
|
||||||
</span>
|
</span>
|
||||||
{unread[tab.name] > 0 && i !== activeTab && (
|
{unread[tab.name] > 0 && i !== activeTab && (
|
||||||
<span class="unread-count">({unread[tab.name]})</span>
|
<span class="unread-count">({unread[tab.name]})</span>
|
||||||
|
|||||||
Reference in New Issue
Block a user