diff options
| -rw-r--r-- | README.md | 69 | ||||
| -rw-r--r-- | go.mod | 2 | ||||
| -rw-r--r-- | go.sum | 6 | ||||
| -rw-r--r-- | interface/matrix.go | 7 | ||||
| -rw-r--r-- | matrix/matrix.go | 19 | ||||
| -rw-r--r-- | ui/command-processor.go | 8 | ||||
| -rw-r--r-- | ui/commands.go | 100 | ||||
| -rw-r--r-- | ui/message-view.go | 10 | ||||
| -rw-r--r-- | ui/messages/parser.go | 1 | ||||
| -rw-r--r-- | ui/room-view.go | 100 |
10 files changed, 255 insertions, 67 deletions
@@ -25,6 +25,9 @@ precompiled executables. For now, you can either download a CI build from Simply pull changes (`git pull`) and run `go build` again to update. +## Debugging +If something doesn't work but it doesn't crash, check the `/tmp/gomuks/debug.log` file for any errors. + ## Developing Set `DEBUG=1` to enable partial deadlock detection and to write panics to stdout instead of a file. @@ -33,8 +36,9 @@ use `go install -race` and set `GORACE='history_size=7 log_path=/tmp/gomuks/race when starting gomuks, then check `/tmp/gomuks/race.log.<pid>`. Note that race detection will use a lot of extra resources. -For debugging, use `tail -f /tmp/gomuks/debug.log` and write to it using the -methods in the `maunium.net/go/gomuks/debug` package: +Proper debuggers are too fancy, but normal prints won't work in a TUI application. To write to the +debug log mentioned previously, use the `maunium.net/go/gomuks/debug` package: + ```go package foo @@ -55,16 +59,51 @@ func Foo() { - jump to room - `Alt + Enter`, then `Tab` and `Enter` to navigate and select room ### Commands -* `/help` - View command list -* `/me <text>` - Send an emote -* `/quit` - Close gomuks -* `/clearcache` - Clear room state and close gomuks -* `/leave` - Leave the current room -* `/create <room name>` - Create a new Matrix room. -* `/join <room>` - Join the room with the given room ID or alias -* `/toggle <rooms/users/baremessages/images/typingnotif>` - Change user preferences -* `/logout` - Log out, clear caches and go back to the login view -* `/send <room id> <event type> <content>` - Send a custom event -* `/setstate <room id> <event type> <state key/-> <content>` - Change room state -* `/msend <event type> <content>` - Send a custom event to the current room -* `/msetstate <event type> <state key/-> <content>` - Change room state in the current room +#### General +* `/help` - View command list. +* `/quit` - Close gomuks. +* `/clearcache` - Clear room state and close gomuks. +* `/logout` - Log out, clear caches and go back to the login view. +* `/toggle <rooms/users/baremessages/images/typingnotif>` - Change user preferences. + +#### Sending special messages +* `/me <text>` - Send an emote. +* `/notice <text>` - Send a notice (generally used for bot messages). +* `/rainbow <text>` - Send rainbow text (markdown not supported). +* `/rainbowme <text>` - Send rainbow text in an emote. +* `/reply [text]` - Reply to the selected message. If text is not specified, the next message will be used. +* `/react <reaction>` - React to the selected message. +* `/redact` - Redact the selected message. + +#### Rooms +##### Creating +* `/pm <user id> [...]` - Start a private chat with the given user(s). +* `/create [room name]` - Create a new room. +##### Joining +* `/join <room> [server]` - Join the room with the given room ID or alias, optionally through the given server. +* `/accept` (in a room you're invited to) - Accept the invite. +* `/reject` (in a room you're invited to) - Reject the invite. +##### Existing +* `/invite <user id>` - Invite the given user ID to the room. +* `/roomnick <name>` - Change your per-room displayname. +* `/tag <tag> <priority>` - Add the room to `<tag>`. `<tag>` should start with `u.` and `<priority>` + should be a float between 0 and 1. Rooms are sorted in ascending priority order. +* `/untag <tag>` - Remove the room from `<tag>`. +* `/tags` - List the tags the room is in. +##### Leaving +* `/leave` - Leave the current room. +* `/kick <user id> [reason]` - Kick a user. +* `/ban <user id> [reason]` - Ban a user. +* `/unban <user id>` - Unban a user. + +#### Raw events +* `/send <room id> <event type> <content>` - Send a custom event. +* `/setstate <room id> <event type> <state key/-> <content>` - Change room state. +* `/msend <event type> <content>` - Send a custom event to the current room. +* `/msetstate <event type> <state key/-> <content>` - Change room state in the current room. +* `/id` - Get the current room ID. + +#### Debugging +* `/hprof` - Create a heap profile and write it to `gomuks.heap.prof` in the current directory. +* `/pprof <seconds>` - Profile the CPU usage for the given number of seconds and write it to `gomuks.cpu.prof`. +* `/trace <seconds>` - Trace calls for the given number of seconds and write traces to `gomuks.trace`. @@ -19,7 +19,7 @@ require ( golang.org/x/net v0.0.0-20200202094626-16171245cfb2 gopkg.in/toast.v1 v1.0.0-20180812000517-0a84660828b2 gopkg.in/yaml.v2 v2.2.8 - maunium.net/go/mautrix v0.1.0-alpha.3.0.20200221234248-8a868bce2854 + maunium.net/go/mautrix v0.1.0-alpha.3.0.20200229232321-dfc638ec809a maunium.net/go/mauview v0.0.0-20200220222850-39f1414676d9 maunium.net/go/tcell v1.1.2-0.20200218183045-87c4a25c5b09 ) @@ -86,6 +86,12 @@ maunium.net/go/mautrix v0.1.0-alpha.3.0.20200221220303-b441ba9359cf h1:ojEsISqRL maunium.net/go/mautrix v0.1.0-alpha.3.0.20200221220303-b441ba9359cf/go.mod h1:g10T1fh2Q2HkJWycVs93eBXdWpqD67f1YVQhNxdIDr4= maunium.net/go/mautrix v0.1.0-alpha.3.0.20200221234248-8a868bce2854 h1:NKj52IqLkfscNMSbSVepaXHM6M/x3iNe/iWSAcmAilo= maunium.net/go/mautrix v0.1.0-alpha.3.0.20200221234248-8a868bce2854/go.mod h1:g10T1fh2Q2HkJWycVs93eBXdWpqD67f1YVQhNxdIDr4= +maunium.net/go/mautrix v0.1.0-alpha.3.0.20200229222711-57beb97fdccb h1:b9cMiQ85HtNhV/gItnjdEFC7nQTWmvnALiHQiYqrJAU= +maunium.net/go/mautrix v0.1.0-alpha.3.0.20200229222711-57beb97fdccb/go.mod h1:g10T1fh2Q2HkJWycVs93eBXdWpqD67f1YVQhNxdIDr4= +maunium.net/go/mautrix v0.1.0-alpha.3.0.20200229230354-be576ef8fcb1 h1:2XQfQNWeNhhEXrb2HgOpTi26o7qq17lQCwSl6wDz2WM= +maunium.net/go/mautrix v0.1.0-alpha.3.0.20200229230354-be576ef8fcb1/go.mod h1:g10T1fh2Q2HkJWycVs93eBXdWpqD67f1YVQhNxdIDr4= +maunium.net/go/mautrix v0.1.0-alpha.3.0.20200229232321-dfc638ec809a h1:/n9qM9C2c3YUz4S8K2apTxpm2xdZ+7cxGsFi9GJdSfc= +maunium.net/go/mautrix v0.1.0-alpha.3.0.20200229232321-dfc638ec809a/go.mod h1:g10T1fh2Q2HkJWycVs93eBXdWpqD67f1YVQhNxdIDr4= maunium.net/go/mauview v0.0.0-20200218183549-88ecb1321176 h1:KoTm7ASEzFIZ1SvPWuWYzpkeA+wiR1fuUu4l7TCHcE0= maunium.net/go/mauview v0.0.0-20200218183549-88ecb1321176/go.mod h1:jwg3Ow7akzsCX3q38pZAfmEC5gGN8gXwMyyjy/yZVMg= maunium.net/go/mauview v0.0.0-20200218231215-04d01c601d5b h1:Bfov5IkJQpkqDexiFioHIZpx4XL7AILDA1GwLVdqtBw= diff --git a/interface/matrix.go b/interface/matrix.go index 0b1278d..34e8dda 100644 --- a/interface/matrix.go +++ b/interface/matrix.go @@ -23,6 +23,11 @@ import ( "maunium.net/go/gomuks/matrix/rooms" ) +type Relation struct { + Type mautrix.RelationType + Event *event.Event +} + type MatrixContainer interface { Client() *mautrix.Client InitClient() error @@ -35,7 +40,7 @@ type MatrixContainer interface { Logout() SendPreferencesToMatrix() - PrepareMarkdownMessage(roomID string, msgtype mautrix.MessageType, message string, edit *event.Event) *event.Event + PrepareMarkdownMessage(roomID string, msgtype mautrix.MessageType, message string, relation *Relation) *event.Event SendEvent(evt *event.Event) (string, error) SendTyping(roomID string, typing bool) MarkRead(roomID, eventID string) diff --git a/matrix/matrix.go b/matrix/matrix.go index 85c4a46..8cf2e96 100644 --- a/matrix/matrix.go +++ b/matrix/matrix.go @@ -729,18 +729,11 @@ func (c *Container) MarkRead(roomID, eventID string) { _, _ = c.client.MakeRequest("POST", urlPath, struct{}{}, nil) } -var mentionRegex = regexp.MustCompile("\\[(.+?)]\\(https://matrix.to/#/@.+?:.+?\\)") -var roomRegex = regexp.MustCompile("\\[.+?]\\(https://matrix.to/#/(#.+?:[^/]+?)\\)") - -func (c *Container) PrepareMarkdownMessage(roomID string, msgtype mautrix.MessageType, text string, edit *event.Event) *event.Event { +func (c *Container) PrepareMarkdownMessage(roomID string, msgtype mautrix.MessageType, text string, rel *ifc.Relation) *event.Event { content := format.RenderMarkdown(text) content.MsgType = msgtype - // Remove markdown link stuff from plaintext mentions and room links - content.Body = mentionRegex.ReplaceAllString(content.Body, "$1") - content.Body = roomRegex.ReplaceAllString(content.Body, "$1") - - if edit != nil { + if rel != nil && rel.Type == mautrix.RelReplace { contentCopy := content content.NewContent = &contentCopy content.Body = "* " + content.Body @@ -749,8 +742,10 @@ func (c *Container) PrepareMarkdownMessage(roomID string, msgtype mautrix.Messag } content.RelatesTo = &mautrix.RelatesTo{ Type: mautrix.RelReplace, - EventID: edit.ID, + EventID: rel.Event.ID, } + } else if rel != nil && rel.Type == mautrix.RelReference { + content.SetReply(rel.Event.Event) } txnID := c.client.TxnID() @@ -766,8 +761,8 @@ func (c *Container) PrepareMarkdownMessage(roomID string, msgtype mautrix.Messag }, }) localEcho.Gomuks.OutgoingState = event.StateLocalEcho - if edit != nil { - localEcho.ID = edit.ID + if rel != nil && rel.Type == mautrix.RelReplace { + localEcho.ID = rel.Event.ID localEcho.Gomuks.Edits = []*event.Event{localEcho} } return localEcho diff --git a/ui/command-processor.go b/ui/command-processor.go index c4dabbd..3212dae 100644 --- a/ui/command-processor.go +++ b/ui/command-processor.go @@ -87,6 +87,11 @@ func NewCommandProcessor(parent *MainView) *CommandProcessor { "createroom": {"create"}, "dm": {"pm"}, "query": {"pm"}, + "r": {"reply"}, + "delete": {"redact"}, + "remove": {"redact"}, + "rm": {"redact"}, + "del": {"redact"}, }, commands: map[string]CommandHandler{ "unknown-command": cmdUnknownCommand, @@ -107,6 +112,9 @@ func NewCommandProcessor(parent *MainView) *CommandProcessor { "logout": cmdLogout, "accept": cmdAccept, "reject": cmdReject, + "reply": cmdReply, + "redact": cmdRedact, + "react": cmdReact, "sendevent": cmdSendEvent, "msendevent": cmdMSendEvent, "setstate": cmdSetState, diff --git a/ui/commands.go b/ui/commands.go index 0adbb61..c7f0301 100644 --- a/ui/commands.go +++ b/ui/commands.go @@ -41,7 +41,6 @@ import ( func cmdMe(cmd *Command) { text := strings.Join(cmd.Args, " ") go cmd.Room.SendMessage(mautrix.MsgEmote, text) - cmd.UI.Render() } // GradientTable from https://github.com/lucasb-eyer/go-colorful/blob/master/doc/gradientgen/gradientgen.go @@ -87,10 +86,9 @@ func makeRainbow(cmd *Command, msgtype mautrix.MessageType) { continue } color := rainbow.GetInterpolatedColorFor(float64(i) / float64(len(text))).Hex() - _, _ = fmt.Fprintf(&html, "<font color=\"%s\">%c</font>", color, char) + _, _ = fmt.Fprintf(&html, "<font data-mx-color=\"%[1]s\" color=\"%[1]s\">%[2]c</font>", color, char) } go cmd.Room.SendMessage(msgtype, html.String()) - cmd.UI.Render() } func cmdRainbow(cmd *Command) { @@ -103,7 +101,6 @@ func cmdRainbowMe(cmd *Command) { func cmdNotice(cmd *Command) { go cmd.Room.SendMessage(mautrix.MsgNotice, strings.Join(cmd.Args, " ")) - cmd.UI.Render() } func cmdAccept(cmd *Command) { @@ -141,6 +138,42 @@ func cmdID(cmd *Command) { cmd.Reply("The internal ID of this room is %s", cmd.Room.MxRoom().ID) } +type SelectReason string + +const ( + SelectReply SelectReason = "reply to" + SelectReact = "react to" + SelectRedact = "redact" +) + +func cmdReply(cmd *Command) { + cmd.Room.selecting = true + cmd.Room.selectReason = SelectReply + cmd.Room.selectContent = strings.Join(cmd.Args, " ") + cmd.Room.OnSelect(cmd.Room.MessageView().selected) +} + +func cmdRedact(cmd *Command) { + cmd.Reply("Not yet implemented 3:") + + // This needs to be implemented in RoomView's OnSelect method + //cmd.Room.selecting = true + //cmd.Room.selectReason = SelectRedact + //cmd.Room.OnSelect(cmd.Room.MessageView().selected) +} + +func cmdReact(cmd *Command) { + if len(cmd.Args) == 0 { + cmd.Reply("Usage: /react <reaction>") + return + } + + cmd.Room.selecting = true + cmd.Room.selectReason = SelectReact + cmd.Room.selectContent = strings.Join(cmd.Args, " ") + cmd.Room.OnSelect(cmd.Room.MessageView().selected) +} + func cmdTags(cmd *Command) { tags := cmd.Room.MxRoom().RawTags if len(cmd.Args) > 0 && cmd.Args[0] == "--internal" { @@ -284,31 +317,42 @@ func cmdUnknownCommand(cmd *Command) { } func cmdHelp(cmd *Command) { - cmd.Reply(`/help - Show the temporary help message. - -/quit - Quit gomuks. -/clearcache - Clear cache and quit gomuks. -/logout - Log out of Matrix. - -/me <message> - Send an emote message. -/rainbow <message> - Send a rainbow message (markdown not supported). - -/create [room name] - Create a room. -/pm <user id> <...> - Create a private chat with the given user(s). -/join <room address> - Join a room. -/leave - Leave the current room. - -/invite <user id> - Invite a user. + cmd.Reply(`# General +/help - Show this "temporary" help message. +/quit - Quit gomuks. +/clearcache - Clear cache and quit gomuks. +/logout - Log out of Matrix. +/toggle <thing> - Temporary command to toggle various UI features. + +Things: rooms, users, baremessages, images, typingnotif + +# Sending special messages +/me <message> - Send an emote message. +/notice <message> - Send a notice (generally used for bot messages). +/rainbow <message> - Send rainbow text (markdown not supported). +/rainbowme <message> - Send rainbow text in an emote. +/reply [text] - Reply to the selected message. +/react <reaction> - React to the selected message. +/redact - Redact the selected message. + +# Rooms +/pm <user id> <...> - Create a private chat with the given user(s). +/create [room name] - Create a room. + +/join <room> [server] - Join a room. +/accept - Accept the invite. +/reject - Reject the invite. + +/invite <user id> - Invite the given user to the room. +/roomnick <name> - Change your per-room displayname. +/tag <tag> <priority> - Add the room to <tag>. +/untag <tag> - Remove the room from <tag>. +/tags - List the tags the room is in. + +/leave - Leave the current room. /kick <user id> [reason] - Kick a user. /ban <user id> [reason] - Ban a user. -/unban <user id> - Unban a user. - -/send <room id> <type> <json> - Send a custom event to the given room. -/msend <type> <json> - Send a custom event to the current room. -/setstate <room id> <type> <key/-> <json> - Send a custom event to the given room. -/msetstate <type> <key/-> <json> - Send a custom event to the current room. - -/toggle <thing> - Temporary command to toggle various UI features.`) +/unban <user id> - Unban a user.`) } func cmdLeave(cmd *Command) { @@ -432,7 +476,6 @@ func cmdMSendEvent(cmd *Command) { } func cmdSendEvent(cmd *Command) { - debug.Print(cmd.Command, cmd.Args, len(cmd.Args)) if len(cmd.Args) < 3 { cmd.Reply("Usage: /send <room id> <event type> <content>") return @@ -440,7 +483,6 @@ func cmdSendEvent(cmd *Command) { roomID := cmd.Args[0] eventType := mautrix.NewEventType(cmd.Args[1]) rawContent := strings.Join(cmd.Args[2:], " ") - debug.Print(roomID, eventType, rawContent) var content interface{} err := json.Unmarshal([]byte(rawContent), &content) diff --git a/ui/message-view.go b/ui/message-view.go index 3635a7b..6fa579a 100644 --- a/ui/message-view.go +++ b/ui/message-view.go @@ -338,7 +338,11 @@ func (view *MessageView) SetSelected(message *messages.UIMessage) { if view.selected != nil { view.selected.IsSelected = false } - view.selected = message + if message != nil && (view.selected == message || message.IsService) { + view.selected = nil + } else { + view.selected = message + } if view.selected != nil { view.selected.IsSelected = true } @@ -349,11 +353,9 @@ func (view *MessageView) handleMessageClick(message *messages.UIMessage, mod tce open.Open(msg.Path()) // No need to re-render return false - } else if message.IsService { - // Can't select service messages - return false } view.SetSelected(message) + view.parent.OnSelect(view.selected) return true } diff --git a/ui/messages/parser.go b/ui/messages/parser.go index e4bbc30..75c564e 100644 --- a/ui/messages/parser.go +++ b/ui/messages/parser.go @@ -129,7 +129,6 @@ func ParseMessage(matrix ifc.MatrixContainer, room *rooms.Room, evt *event.Event evt.Content.RemoveReplyFallback() } if len(evt.Gomuks.Edits) > 0 { - evt = evt.SomewhatDangerousCopy() evt.Content = *evt.Gomuks.Edits[len(evt.Gomuks.Edits)-1].Content.NewContent } switch evt.Content.MsgType { diff --git a/ui/room-view.go b/ui/room-view.go index ab31ca7..07aaef9 100644 --- a/ui/room-view.go +++ b/ui/room-view.go @@ -67,6 +67,12 @@ type RoomView struct { typing []string + selecting bool + selectReason SelectReason + selectContent string + + replying *event.Event + editing *event.Event editMoveText string @@ -148,14 +154,43 @@ func (view *RoomView) Focus() { } func (view *RoomView) Blur() { + view.MessageView().SetSelected(nil) view.input.Blur() } +func (view *RoomView) OnSelect(message *messages.UIMessage) { + if !view.selecting || message == nil { + return + } + switch view.selectReason { + case SelectReply: + view.replying = message.Event + if len(view.selectContent) > 0 { + go view.SendMessage(mautrix.MsgText, view.selectContent) + } + case SelectReact: + go view.SendReaction(message.EventID, view.selectContent) + case SelectRedact: + // TODO redact + } + view.selecting = false + view.selectContent = "" + view.MessageView().SetSelected(nil) +} + func (view *RoomView) GetStatus() string { var buf strings.Builder if view.editing != nil { buf.WriteString("Editing message - ") + } else if view.replying != nil { + buf.WriteString("Replying to ") + buf.WriteString(view.replying.Sender) + buf.WriteString(" - ") + } else if view.selecting { + buf.WriteString("Selecting message to ") + buf.WriteString(string(view.selectReason)) + buf.WriteString(" - ") } if len(view.completions.list) > 0 { @@ -245,9 +280,19 @@ func (view *RoomView) Draw(screen mauview.Screen) { } } +func (view *RoomView) ClearAllContext() { + view.MessageView().SetSelected(nil) + view.SetEditing(nil) + view.replying = nil + view.selecting = false + view.selectContent = "" +} + func (view *RoomView) OnKeyEvent(event mauview.KeyEvent) bool { msgView := view.MessageView() switch event.Key() { + case tcell.KeyEscape: + view.ClearAllContext() case tcell.KeyPgUp: if msgView.IsAtTop() { go view.parent.LoadHistory(view.Room.ID) @@ -373,6 +418,8 @@ func (view *RoomView) SetEditing(evt *event.Event) { view.editMoveText = view.GetInputText() } view.editing = evt + // replying should never be non-nil when SetEditing, but do this just to be safe + view.replying = nil text := view.editing.Content.Body if view.editing.Content.MsgType == mautrix.MsgEmote { text = "/me " + text @@ -393,7 +440,9 @@ func (view *RoomView) findMessageToEdit(forward bool) *event.Event { index = len(msgs) - i - 1 } evt := msgs[index] - if currentFound { + if evt.EventID == "" || evt.EventID == evt.TxnID { + continue + } else if currentFound { if evt.SenderID == self && evt.Event.Type == mautrix.EventMessage { return evt.Event } @@ -413,6 +462,9 @@ func (view *RoomView) EditNext() { } func (view *RoomView) EditPrevious() { + if view.replying != nil { + return + } foundEvent := view.findMessageToEdit(false) if foundEvent != nil { view.SetEditing(foundEvent) @@ -470,16 +522,56 @@ func (view *RoomView) InputSubmit(text string) { view.SetInputText("") } +func (view *RoomView) SendReaction(eventID string, reaction string) { + defer debug.Recover() + debug.Print("Reacting to", eventID, "in", view.Room.ID, "with", reaction) + eventID, err := view.parent.matrix.SendEvent(&event.Event{ + Event: &mautrix.Event{ + Type: mautrix.EventReaction, + RoomID: view.Room.ID, + Content: mautrix.Content{ + RelatesTo: &mautrix.RelatesTo{ + Type: mautrix.RelAnnotation, + EventID: eventID, + Key: reaction, + }, + }, + }, + }) + if err != nil { + if httpErr, ok := err.(mautrix.HTTPError); ok { + err = httpErr + if respErr := httpErr.RespError; respErr != nil { + err = respErr + } + } + view.AddServiceMessage(fmt.Sprintf("Failed to send reaction: %v", err)) + view.parent.parent.Render() + } +} + func (view *RoomView) SendMessage(msgtype mautrix.MessageType, text string) { defer debug.Recover() debug.Print("Sending message", msgtype, text, "to", view.Room.ID) if !view.config.Preferences.DisableEmojis { text = emoji.Sprint(text) } - evt := view.parent.matrix.PrepareMarkdownMessage(view.Room.ID, msgtype, text, view.editing) - msg := view.parseEvent(evt) + var rel *ifc.Relation + if view.editing != nil { + rel = &ifc.Relation{ + Type: mautrix.RelReplace, + Event: view.editing, + } + } else if view.replying != nil { + rel = &ifc.Relation{ + Type: mautrix.RelReference, + Event: view.replying, + } + } + evt := view.parent.matrix.PrepareMarkdownMessage(view.Room.ID, msgtype, text, rel) + msg := view.parseEvent(evt.SomewhatDangerousCopy()) view.content.AddMessage(msg, AppendMessage) - view.editing = nil + view.ClearAllContext() view.status.SetText(view.GetStatus()) eventID, err := view.parent.matrix.SendEvent(evt) if err != nil { |