readme

.hgignore

@@ -1,6 +1,14 @@
 mode:regex
 
+# Compilation output
 \.(?:exe|a)$
 ^pkg/
 
+# Dependencies
 ^src/(?:github.com|gopkg.in|golang.org)/
+
+# Scratch space
+^src/nmdc/
+
+# Binary release artefacts
+/?__dist/

.hgtags

@@ -0,0 +1,14 @@
+945ab4b16d05aa084f71bf5da9a3f687e0ec8bbd libnmdc-r1
+02a360e95480b97ddad83add5db48b2766339a99 nmdc-log-service-1.0.0
+137c1b65039e03c80379826a6efdfd808f6fbc8f libnmdc-r2
+d8b64d5527c2a5e4d76872e5bc3d69f7646135c6 libnmdc-r3
+fca41372e400853775b02e951f9db91d87f41adb nmdc-log-service-1.0.1
+050b424a7c5d5a27c9323c8810f3afbead1f5b96 libnmdc-r4
+da9f123633f9c28be6435ed7898139665d4c39d9 nmdc-log-service-1.0.2
+75a78f6a78f249a2cd8aa3d29f7e5e6319b4e03b libnmdc-r5
+4116422bb10229d887f9296970a166fa1ef8c5fd nmdc-log-service-1.0.3
+cb86f3a40115cc46f450c0c83fd9b9d3b740e820 nmdc-log-service-1.0.4
+cb86f3a40115cc46f450c0c83fd9b9d3b740e820 libnmdc-r6
+71343a2c641a438206d30ea7e75dc89a11dbef00 libnmdc-r7
+b0e57a5fcffdf4102d669db51a3648ddf66a0792 libnmdc-r8
+e7c2c71ef24b386add728fad35fff4a996fccbac libnmdc-r9

ConnectionState.go

@@ -0,0 +1,40 @@
+package libnmdc
+
+import (
+	"net"
+)
+
+type ConnectionState int
+
+const (
+	CONNECTIONSTATE_DISCONNECTED = 1
+	CONNECTIONSTATE_CONNECTING   = 2 // Handshake in progress
+	CONNECTIONSTATE_CONNECTED    = 3
+)
+
+func (cs ConnectionState) Format() string {
+	switch cs {
+	case CONNECTIONSTATE_DISCONNECTED:
+		return "Disconnected"
+	case CONNECTIONSTATE_CONNECTING:
+		return "Connecting"
+	case CONNECTIONSTATE_CONNECTED:
+		return "Connected"
+	default:
+		return "?"
+	}
+}
+
+func CheckIsNetTimeout(err error) bool {
+	if err == nil {
+		return false
+	}
+
+	switch err.(type) {
+	case net.Error:
+		return err.(net.Error).Timeout()
+
+	default:
+		return false
+	}
+}

HubAddress.go

@@ -0,0 +1,35 @@
+package libnmdc
+
+import (
+	"net/url"
+	"strings"
+)
+
+type HubAddress string
+
+func (this *HubAddress) parse() url.URL {
+	parsed, err := url.Parse(strings.ToLower(string(*this)))
+	if err != nil || len(parsed.Host) == 0 {
+		parsed = &url.URL{
+			Scheme: "nmdc",
+			Host:   string(*this),
+		}
+	}
+
+	// Add default port if not specified
+	if !strings.ContainsRune(parsed.Host, ':') {
+		parsed.Host = parsed.Host + ":411"
+	}
+
+	return *parsed
+}
+
+func (this *HubAddress) IsSecure() bool {
+	parsed := this.parse()
+
+	return parsed.Scheme == "nmdcs" || parsed.Scheme == "dchubs"
+}
+
+func (this *HubAddress) GetHostOnly() string {
+	return this.parse().Host
+}

HubConnection.go

@@ -0,0 +1,373 @@
+package libnmdc
+
+import (
+	"crypto/tls"
+	"net"
+	"strconv"
+	"strings"
+	"sync"
+	"time"
+)
+
+type HubConnection struct {
+	// Supplied parameters
+	Hco *HubConnectionOptions
+
+	// Current remote status
+	HubName  string
+	State    ConnectionState
+	users    map[string]UserInfo
+	userLock sync.RWMutex
+
+	// Streamed events
+	processEvent func(HubEvent)
+	OnEvent      chan HubEvent
+
+	// Private state
+	conn          net.Conn // this is an interface
+	connValid     bool
+	sentOurHello  bool
+	autoReconnect bool
+}
+
+func (this *HubConnection) Users(cb func(*map[string]UserInfo) error) error {
+	this.userLock.Lock()
+	defer this.userLock.Unlock()
+
+	return cb(&this.users)
+}
+
+func (this *HubConnection) SayPublic(message string) {
+	this.SayRaw("<" + this.Hco.Self.Nick + "> " + NMDCEscape(message) + "|")
+}
+
+func (this *HubConnection) SayPrivate(recipient string, message string) {
+	this.SayRaw("$To: " + recipient + " From: " + this.Hco.Self.Nick + " $<" + this.Hco.Self.Nick + "> " + NMDCEscape(message) + "|")
+}
+
+func (this *HubConnection) SayInfo() {
+	this.SayRaw(this.Hco.Self.toMyINFO() + "|")
+}
+
+func (this *HubConnection) UserExists(nick string) bool {
+	this.userLock.RLock()
+	defer this.userLock.RUnlock()
+
+	_, already_existed := this.users[nick]
+	return already_existed
+}
+
+func (this *HubConnection) UserCount() int {
+	this.userLock.RLock()
+	defer this.userLock.RUnlock()
+
+	return len(this.users)
+}
+
+func (this *HubConnection) userJoined_NameOnly(nick string) {
+	if !this.UserExists(nick) {
+		this.userLock.Lock()
+		defer this.userLock.Unlock()
+
+		this.users[nick] = *NewUserInfo(nick)
+		this.processEvent(HubEvent{EventType: EVENT_USER_JOINED, Nick: nick})
+	}
+}
+
+func (this *HubConnection) userJoined_Full(uinf *UserInfo) {
+	// n.b. also called when we get a replacement MyINFO for someone
+	this.userLock.Lock()
+	defer this.userLock.Unlock()
+
+	_, userExisted := this.users[uinf.Nick] // don't use UserExists as it would deadlock the mutex
+
+	this.users[uinf.Nick] = *uinf
+
+	if !userExisted {
+		this.processEvent(HubEvent{EventType: EVENT_USER_JOINED, Nick: uinf.Nick})
+	}
+}
+
+// Note that protocol messages are transmitted on the caller thread, not from
+// any internal libnmdc thread.
+func (this *HubConnection) SayRaw(protocolCommand string) error {
+	if this.connValid {
+		_, err := this.conn.Write([]byte(protocolCommand))
+		return err
+	} else {
+		return ErrNotConnected
+	}
+}
+
+func (this *HubConnection) processProtocolMessage(message string) {
+
+	// Zero-length protocol message
+	// ````````````````````````````
+	if len(message) == 0 {
+		return
+	}
+
+	// Public chat
+	// ```````````
+	if rx_publicChat.MatchString(message) {
+		pubchat_parts := rx_publicChat.FindStringSubmatch(message)
+		this.processEvent(HubEvent{EventType: EVENT_PUBLIC, Nick: pubchat_parts[1], Message: NMDCUnescape(pubchat_parts[2])})
+		return
+	}
+
+	// System messages
+	// ```````````````
+	if message[0] != '$' {
+		this.processEvent(HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_HUB, Nick: this.HubName, Message: NMDCUnescape(message)})
+		return
+	}
+
+	// Protocol messages
+	// `````````````````
+
+	commandParts := strings.SplitN(message, " ", 2)
+	switch commandParts[0] {
+
+	case "$Lock":
+		this.SayRaw("$Supports NoGetINFO UserCommand UserIP2|" +
+			"$Key " + NMDCUnlock([]byte(commandParts[1])) + "|" +
+			"$ValidateNick " + NMDCEscape(this.Hco.Self.Nick) + "|")
+		this.sentOurHello = false
+
+	case "$Hello":
+		if commandParts[1] == this.Hco.Self.Nick && !this.sentOurHello {
+			this.SayRaw("$Version 1,0091|")
+			this.SayRaw("$GetNickList|")
+			this.SayInfo()
+			this.sentOurHello = true
+
+		} else {
+			this.userJoined_NameOnly(commandParts[1])
+
+		}
+
+	case "$HubName":
+		this.HubName = commandParts[1]
+		this.processEvent(HubEvent{EventType: EVENT_HUBNAME_CHANGED, Nick: commandParts[1]})
+
+	case "$ValidateDenide": // sic
+		if len(this.Hco.NickPassword) > 0 {
+			this.processEvent(HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_CONN, Message: "Incorrect password."})
+		} else {
+			this.processEvent(HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_CONN, Message: "Nick already in use."})
+		}
+
+	case "$HubIsFull":
+		this.processEvent(HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_CONN, Message: "Hub is full."})
+
+	case "$BadPass":
+		this.processEvent(HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_CONN, Message: "Incorrect password."})
+
+	case "$GetPass":
+		this.SayRaw("$MyPass " + NMDCEscape(this.Hco.NickPassword) + "|")
+
+	case "$Quit":
+		func() {
+			this.userLock.Lock()
+			defer this.userLock.Unlock()
+
+			delete(this.users, commandParts[1])
+		}()
+		this.processEvent(HubEvent{EventType: EVENT_USER_PART, Nick: commandParts[1]})
+
+	case "$MyINFO":
+		u := UserInfo{}
+		err := u.fromMyINFO(commandParts[1])
+		if err == nil {
+			this.userJoined_Full(&u)
+		} else {
+			this.processEvent(HubEvent{EventType: EVENT_DEBUG_MESSAGE, Message: err.Error()})
+		}
+
+	case "$NickList":
+		nicklist := strings.Split(commandParts[1], "$$")
+		for _, nick := range nicklist {
+			if len(nick) > 0 {
+				this.userJoined_NameOnly(nick)
+			}
+		}
+
+	case "$OpList":
+		oplist := strings.Split(commandParts[1], "$$")
+		opmap := map[string]struct{}{}
+
+		// Organise/sort the list, and ensure we're not meeting an operator for
+		//  the first time
+		for _, nick := range oplist {
+			if len(nick) > 0 {
+				opmap[nick] = struct{}{}
+				this.userJoined_NameOnly(nick) // assert existence; noop otherwise
+			}
+		}
+
+		// Mark all mentioned nicks as being operators, and all unmentioned nicks
+		//  as being /not/ an operator. (second pass minimises RW mutex use)
+		func() {
+			this.userLock.Lock()
+			defer this.userLock.Unlock()
+
+			for nick, userinfo := range this.users {
+				_, isop := opmap[nick]
+
+				userinfo.IsOperator = isop
+				this.users[nick] = userinfo
+			}
+		}()
+
+	case "$To:":
+		valid := false
+		if rx_incomingTo.MatchString(commandParts[1]) {
+			txparts := rx_incomingTo.FindStringSubmatch(commandParts[1])
+			if txparts[1] == this.Hco.Self.Nick && txparts[2] == txparts[3] {
+				this.processEvent(HubEvent{EventType: EVENT_PRIVATE, Nick: txparts[2], Message: txparts[4]})
+				valid = true
+			}
+		}
+
+		if !valid {
+			this.processEvent(HubEvent{EventType: EVENT_DEBUG_MESSAGE, Message: "Malformed private message '" + commandParts[1] + "'"})
+		}
+
+	case "$UserIP":
+		// Final message in PtokaX connection handshake - trigger connection callback.
+		// This might not be the case for other hubsofts, though
+		if this.State != CONNECTIONSTATE_CONNECTED {
+			this.processEvent(HubEvent{EventType: EVENT_CONNECTION_STATE_CHANGED, StateChange: CONNECTIONSTATE_CONNECTED})
+			this.State = CONNECTIONSTATE_CONNECTED
+		}
+
+	case "$ForceMove":
+		this.Hco.Address = HubAddress(commandParts[1])
+		this.conn.Close() // we'll reconnect onto the new address
+
+	case "$UserCommand":
+		// $UserCommand 1 1 Group chat\New group chat$<%[mynick]> !groupchat_new&#124;|
+		if rx_userCommand.MatchString(commandParts[1]) {
+			usc := rx_userCommand.FindStringSubmatch(commandParts[1])
+
+			typeInt, _ := strconv.Atoi(usc[1])
+			contextInt, _ := strconv.Atoi(usc[2])
+
+			uscStruct := UserCommand{
+				Type:    UserCommandType(typeInt),
+				Context: UserCommandContext(contextInt),
+				Message: usc[3],
+				Command: NMDCUnescape(usc[4]),
+			}
+
+			this.processEvent(HubEvent{EventType: EVENT_USERCOMMAND, UserCommand: &uscStruct})
+
+		} else {
+			this.processEvent(HubEvent{EventType: EVENT_DEBUG_MESSAGE, Message: "Malformed usercommand '" + commandParts[1] + "'"})
+		}
+
+	// IGNORABLE COMMANDS
+	case "$Supports":
+	case "$HubTopic":
+	case "$Search":
+	case "$ConnectToMe":
+
+	default:
+		this.processEvent(HubEvent{EventType: EVENT_DEBUG_MESSAGE, Message: "Unhandled protocol command '" + commandParts[0] + "'"})
+
+	}
+}
+
+func (this *HubConnection) Disconnect() {
+	this.autoReconnect = false
+	if this.conn != nil {
+		this.conn.Close()
+	}
+	// A CONNECTIONSTATE_DISCONNECTED message will be emitted by the worker.
+}
+
+func (this *HubConnection) worker() {
+	var fullBuffer string
+	var err error = nil
+	var nbytes int = 0
+
+	for {
+
+		// If we're not connected, attempt reconnect
+		if this.conn == nil {
+
+			fullBuffer = "" // clear
+
+			if this.Hco.Address.IsSecure() {
+				this.conn, err = tls.Dial("tcp", this.Hco.Address.GetHostOnly(), &tls.Config{
+					InsecureSkipVerify: this.Hco.SkipVerifyTLS,
+				})
+			} else {
+				this.conn, err = net.Dial("tcp", this.Hco.Address.GetHostOnly())
+			}
+
+			if err != nil {
+				this.State = CONNECTIONSTATE_DISCONNECTED
+				this.connValid = false
+
+			} else {
+				this.State = CONNECTIONSTATE_CONNECTING
+				this.connValid = true
+				this.processEvent(HubEvent{EventType: EVENT_CONNECTION_STATE_CHANGED, StateChange: CONNECTIONSTATE_CONNECTING})
+
+			}
+		}
+
+		// Read from socket into our local buffer (blocking)
+		if this.connValid {
+			readBuff := make([]byte, 1024)
+			this.conn.SetReadDeadline(time.Now().Add(SEND_KEEPALIVE_EVERY))
+			nbytes, err = this.conn.Read(readBuff)
+
+			if CheckIsNetTimeout(err) {
+				// No data before read deadline
+				err = nil
+
+				// Send KA packet
+				_, err = this.conn.Write([]byte("|"))
+			}
+
+			if nbytes > 0 {
+				fullBuffer += string(readBuff[0:nbytes])
+			}
+		}
+
+		// Attempt to parse a message block
+		for len(fullBuffer) > 0 {
+			for len(fullBuffer) > 0 && fullBuffer[0] == '|' {
+				fullBuffer = fullBuffer[1:]
+			}
+			protocolMessage := rx_protocolMessage.FindString(fullBuffer)
+			if len(protocolMessage) > 0 {
+				this.processProtocolMessage(protocolMessage[:len(protocolMessage)-1])
+				fullBuffer = fullBuffer[len(protocolMessage):]
+			} else {
+				break
+			}
+		}
+
+		// Maybe we disconnected
+		// Perform this check *last*, to ensure we've had a final shot at
+		//  clearing out any queued messages
+		if err != nil {
+			this.State = CONNECTIONSTATE_DISCONNECTED
+			this.conn = nil
+			this.connValid = false
+			this.processEvent(HubEvent{EventType: EVENT_CONNECTION_STATE_CHANGED, StateChange: CONNECTIONSTATE_DISCONNECTED, Message: err.Error()})
+
+			if this.autoReconnect {
+				time.Sleep(AUTO_RECONNECT_AFTER) // Wait before reconnect
+				continue
+			} else {
+				return // leave the worker for good
+			}
+		}
+
+	}
+
+}

HubConnectionOptions.go

@@ -0,0 +1,58 @@
+package libnmdc
+
+type HubConnectionOptions struct {
+	Address           HubAddress
+	SkipVerifyTLS     bool // using a negative verb, because bools default to false
+	SkipAutoReconnect bool // as above
+	Self              UserInfo
+	NickPassword      string
+
+	// Returning messages in async mode
+	NumEventsToBuffer uint
+
+	// Returning messages in sync mode
+	OnEventSync func(HubEvent)
+}
+
+func (this *HubConnectionOptions) prepareConnection() *HubConnection {
+	if this.Self.ClientTag == "" {
+		this.Self.ClientTag = DEFAULT_CLIENT_TAG
+	}
+
+	hc := HubConnection{
+		Hco:     this,
+		HubName: DEFAULT_HUB_NAME,
+		State:   CONNECTIONSTATE_DISCONNECTED,
+		users:   make(map[string]UserInfo),
+
+		autoReconnect: !this.SkipAutoReconnect,
+	}
+
+	return &hc
+}
+
+// Connects to an NMDC server, and spawns a background goroutine to handle
+// protocol messages. Events will be sent by channel to the returned hc.OnEvent,
+// the client is responsible for selecting off this.
+func (this *HubConnectionOptions) Connect() *HubConnection {
+
+	if this.NumEventsToBuffer < 1 {
+		this.NumEventsToBuffer = 1
+	}
+
+	hc := this.prepareConnection()
+	hc.OnEvent = make(chan HubEvent, this.NumEventsToBuffer)
+	hc.processEvent = func(ev HubEvent) {
+		hc.OnEvent <- ev
+	}
+
+	go hc.worker()
+	return hc
+}
+
+// Connects to an NMDC server, and blocks forever to handle protocol messages.
+// Client code should supply an event handling function as hco.OnEventSync.
+func (this *HubConnectionOptions) ConnectSync() {
+	hc := this.prepareConnection()
+	hc.worker()
+}

HubEvent.go

@@ -0,0 +1,25 @@
+package libnmdc
+
+const (
+	EVENT_PUBLIC                   = 1
+	EVENT_PRIVATE                  = 2
+	EVENT_SYSTEM_MESSAGE_FROM_HUB  = 3
+	EVENT_SYSTEM_MESSAGE_FROM_CONN = 4
+	EVENT_USER_JOINED              = 5
+	EVENT_USER_PART                = 6
+	EVENT_USER_UPDATED_INFO        = 7
+	EVENT_CONNECTION_STATE_CHANGED = 8
+	EVENT_HUBNAME_CHANGED          = 9
+	EVENT_DEBUG_MESSAGE            = 10
+	EVENT_USERCOMMAND              = 11
+)
+
+type HubEventType int
+
+type HubEvent struct {
+	EventType   HubEventType
+	Nick        string
+	Message     string
+	StateChange ConnectionState
+	UserCommand *UserCommand
+}

UserCommand.go

@@ -0,0 +1,26 @@
+package libnmdc
+
+type UserCommandType uint8
+
+const (
+	USERCOMMAND_TYPE_SEPARATOR   UserCommandType = 0
+	USERCOMMAND_TYPE_RAW         UserCommandType = 1
+	USERCOMMAND_TYPE_NICKLIMITED UserCommandType = 2
+	USERCOMMAND_TYPE_CLEARALL    UserCommandType = 255
+)
+
+type UserCommandContext uint8
+
+const (
+	USERCOMMAND_CONTEXT_HUB      UserCommandContext = 1
+	USERCOMMAND_CONTEXT_USER     UserCommandContext = 2
+	USERCOMMAND_CONTEXT_SEARCH   UserCommandContext = 4
+	USERCOMMAND_CONTEXT_FILELIST UserCommandContext = 8
+)
+
+type UserCommand struct {
+	Type    UserCommandType
+	Context UserCommandContext
+	Message string
+	Command string
+}

UserInfo.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"regexp"
 	"strconv"
+	"strings"
 )
 
 type UserFlag byte
@@ -37,6 +38,7 @@ type UserInfo struct {
 	Nick             string
 	Description      string
 	ClientTag        string
+	ClientVersion    string
 	Email            string
 	ShareSize        uint64
 	ConnectionMode   ConnectionMode
@@ -46,6 +48,7 @@ type UserInfo struct {
 	HubsUnregistered uint64
 	HubsRegistered   uint64
 	HubsOperator     uint64
+	IsOperator       bool
 }
 
 var rx_myinfo *regexp.Regexp
@@ -53,12 +56,19 @@ var rx_myinfo_notag *regexp.Regexp
 
 func init() {
 	// $ALL <nick> <description>$ $<connection><flag>$<e-mail>$<sharesize>$
-	rx_myinfo = regexp.MustCompile("(?ms)^\\$ALL ([^ ]+) ([^<]*)<([^,]*),M:(.),H:([0-9]+)/([0-9]+)/([0-9]+),S:([0-9]+)>\\$.\\$(.+?)(.)\\$([^$]*)\\$([0-9]*)\\$$")
-	rx_myinfo_notag = regexp.MustCompile("(?ms)^\\$ALL ([^ ]+) ([^$]*)\\$.\\$(.*)(.)\\$([^$]*)\\$([0-9]*)\\$$") // Fallback for no tag
+
+	HEAD := `(?ms)^\$ALL ([^ ]+) `
+	FOOT := `\$.\$([^$]+)\$([^$]*)\$([0-9]*)\$$`
+
+	rx_myinfo = regexp.MustCompile(HEAD + `([^<]*)<(.+?) V:([^,]+),M:(.),H:([0-9]+)/([0-9]+)/([0-9]+),S:([0-9]+)>` + FOOT)
+	rx_myinfo_notag = regexp.MustCompile(HEAD + `([^$]*)` + FOOT) // Fallback for no tag
 
 	/*
-		sample := "$ALL Betty description<ApexDC++ V:1.4.3,M:P,H:9/0/2,S:1>$ $0.01\x01$xyz@xyz.com$53054999578$"
-		sample = "$ALL ivysaur80 $P$10A$$0$"
+		sample := ""
+		// sample = "$ALL Betty description<ApexDC++ V:1.4.3,M:P,H:9/0/2,S:1>$ $0.01\x01$xyz@xyz.com$53054999578$"
+		// sample = "$ALL ivysaur80 $P$10A$$0$"
+		// sample = "$ALL SHINY_IVYSAUR <ncdc V:1.19.1-12-g5561,M:P,H:1/0/0,S:10>$ $0.005Q$$0$"
+		// sample = "$ALL mappu desccccc<HexChat V:2.12.1,M:P,H:1/0/0,S:0>$ $p$$0$"
 
 		u := UserInfo{}
 		err := u.fromMyINFO(sample)
@@ -68,7 +78,7 @@ func init() {
 			fmt.Printf("%+v\n", u)
 		}
 
-		os.Exit(1)
+		panic("")
 	*/
 }
 
@@ -90,19 +100,25 @@ func maybeParse(str string, dest *uint64, default_val uint64) {
 }
 
 func (this *UserInfo) fromMyINFO(protomsg string) error {
-	// Normal format (with tag in exact M/H/S order)
+
+	// Normal format (with tag in exact V/M/H/S order)
 	matches := rx_myinfo.FindStringSubmatch(protomsg)
 	if matches != nil {
 		this.Nick = matches[1]
 		this.Description = NMDCUnescape(matches[2])
 		this.ClientTag = NMDCUnescape(matches[3])
+		this.ClientVersion = matches[4]
 		this.ConnectionMode = ConnectionMode(matches[4][0])
-		maybeParse(matches[5], &this.HubsUnregistered, 0)
-		maybeParse(matches[6], &this.HubsRegistered, 0)
-		maybeParse(matches[7], &this.HubsOperator, 0)
-		maybeParse(matches[8], &this.Slots, 0)
-		this.Speed = matches[9]
-		this.Flag = UserFlag(matches[10][0])
+		maybeParse(matches[6], &this.HubsUnregistered, 0)
+		maybeParse(matches[7], &this.HubsRegistered, 0)
+		maybeParse(matches[8], &this.HubsOperator, 0)
+		maybeParse(matches[9], &this.Slots, 0)
+		if len(matches[10]) > 1 {
+			this.Speed = matches[10][:len(matches[10])-2]
+		} else {
+			this.Speed = ""
+		}
+		this.Flag = UserFlag(matches[10][len(matches[10])-1])
 		this.Email = NMDCUnescape(matches[11])
 		maybeParse(matches[12], &this.ShareSize, 0)
 
@@ -115,19 +131,27 @@ func (this *UserInfo) fromMyINFO(protomsg string) error {
 		this.Nick = matches[1]
 		this.Description = NMDCUnescape(matches[2])
 		this.ClientTag = ""
+		this.ClientVersion = "0"
 		this.ConnectionMode = CONNECTIONMODE_PASSIVE
 		this.HubsUnregistered = 0
 		this.HubsRegistered = 0
 		this.HubsOperator = 0
 		this.Slots = 0
-		this.Speed = matches[3]
-		this.Flag = UserFlag(matches[4][0])
-		this.Email = NMDCUnescape(matches[5])
-		maybeParse(matches[6], &this.ShareSize, 0)
+
+		if len(matches[3]) > 1 {
+			this.Speed = matches[3][:len(matches[3])-2]
+		} else {
+			this.Speed = ""
+		}
+		this.Flag = UserFlag(matches[3][len(matches[3])-1])
+		this.Email = NMDCUnescape(matches[4])
+		maybeParse(matches[5], &this.ShareSize, 0)
 
 		return nil
 	}
 
+	fmt.Printf("PARSE: malformed\n")
+
 	// Couldn't get anything out of it...
 	return errors.New("Malformed MyINFO")
 }
@@ -135,10 +159,11 @@ func (this *UserInfo) fromMyINFO(protomsg string) error {
 // Returns the MyINFO command, WITH leading $MyINFO, and WITHOUT trailing pipe
 func (this *UserInfo) toMyINFO() string {
 	return fmt.Sprintf(
-		"$MyINFO $ALL %s %s<%s,M:%c,H:%d/%d/%d,S:%d>$ $%s%c$%s$%d$",
+		"$MyINFO $ALL %s %s<%s V:%s,M:%c,H:%d/%d/%d,S:%d>$ $%s%c$%s$%d$",
 		this.Nick,
 		this.Description,
 		this.ClientTag,
+		strings.Replace(this.ClientVersion, ",", "-", -1), // just in case
 		this.ConnectionMode,
 		this.HubsUnregistered,
 		this.HubsRegistered,

__dist/README.txt

@@ -0,0 +1,54 @@
+An NMDC client protocol library for Golang.
+
+- Offers both channel-based and synchronous APIs.
+- Includes a sample logging client using the channel-based API.
+- This code hosting site isn't (yet) compatible with `go get`.
+
+Written in golang
+Tags: nmdc
+
+=CHANGELOG=
+
+2016-10-08 r10
+- Feature: Support `$UserCommand`
+
+2016-08-27 r9
+- Fix an issue with parsing MyINFO strings with zero-length speed descriptions
+- Fix an issue with not storing updated profile information
+
+2016-05-10 r8
+- Enhancement: Separate `ClientTag` and `ClientVersion` in `UserInfo` structs
+
+2016-05-08 r7
+- BREAKING: Remove direct access to `HubConnection.Users` map
+- Feature: Threadsafe user map accessor
+- Feature: Option to disable auto-reconnection
+- Feature: New `Disconnect()`, `UserCount()`, `UserExists()` functions
+- Enhancement: Support `$OpList`, add `IsOperator` member to `UserInfo` structs
+- Refactor into multiple files
+
+2016-04-16 r6
+- Fix an issue with calling `panic()` on certain types of abnormal network failure
+
+2016-04-04 r5
+- Enhancement: Support protocol keepalives
+- Enhancement: Support hub redirects (`$ForceMove`)
+
+2016-04-03 r4
+- Feature: Add synchronous API
+- Fix an issue with reading HubConnection's state parameter
+- Fix an issue with buffered protocol commands
+
+2016-04-03 r3
+- Feature: Add `SkipVerifyTLS` option
+- Fix an issue with calling `panic()` if connection failed
+
+2016-04-02 r2
+- Enhancement: Support NMDC-over-TLS (NMDCS)
+- Fix an issue recieving private messages
+- Fix an issue with calling `panic()` if connection failed
+- Fix an issue parsing URIs without a specified port
+- Move sample content into directory with excluded build
+
+2016-02-12 r1
+- Initial public release

libnmdc.go

@@ -0,0 +1,64 @@
+// libnmdc project libnmdc.go
+package libnmdc
+
+import (
+	"errors"
+	"fmt"
+	"regexp"
+	"strings"
+	"time"
+)
+
+const (
+	DEFAULT_CLIENT_TAG   string        = "libnmdc.go"
+	DEFAULT_HUB_NAME     string        = "(unknown)"
+	SEND_KEEPALIVE_EVERY time.Duration = 29 * time.Second
+	AUTO_RECONNECT_AFTER time.Duration = 30 * time.Second
+)
+
+var rx_protocolMessage *regexp.Regexp
+var rx_publicChat *regexp.Regexp
+var rx_incomingTo *regexp.Regexp
+var rx_userCommand *regexp.Regexp
+var ErrNotConnected error = errors.New("Not connected")
+
+func init() {
+	rx_protocolMessage = regexp.MustCompile("(?ms)^[^|]*\\|")
+	rx_publicChat = regexp.MustCompile("(?ms)^<([^>]*)> (.*)$")
+	rx_incomingTo = regexp.MustCompile("(?ms)^([^ ]+) From: ([^ ]+) \\$<([^>]*)> (.*)")
+	rx_userCommand = regexp.MustCompile(`(?ms)^(\d+) (\d+)\s?([^\$]*)\$?(.*)`)
+}
+
+func NMDCUnescape(encoded string) string {
+	v1 := strings.Replace(encoded, "&#36;", "$", -1)
+	v2 := strings.Replace(v1, "&#124;", "|", -1)
+	return strings.Replace(v2, "&amp;", "&", -1)
+}
+
+func NMDCEscape(plaintext string) string {
+	v1 := strings.Replace(plaintext, "&", "&amp;", -1)
+	v2 := strings.Replace(v1, "|", "&#124;", -1)
+	return strings.Replace(v2, "$", "&#36;", -1)
+}
+
+func NMDCUnlock(lock []byte) string {
+
+	nibble_swap := func(b byte) byte {
+		return ((b << 4) & 0xF0) | ((b >> 4) & 0x0F)
+	}
+
+	chr := func(b byte) string {
+		if b == 0 || b == 5 || b == 36 || b == 96 || b == 124 || b == 126 {
+			return fmt.Sprintf("/%%DCN%04d%%/", b)
+		} else {
+			return string(b)
+		}
+	}
+
+	key := chr(nibble_swap(lock[0] ^ lock[len(lock)-2] ^ lock[len(lock)-3] ^ 5))
+	for i := 1; i < len(lock); i += 1 {
+		key += chr(nibble_swap(lock[i] ^ lock[i-1]))
+	}
+
+	return key
+}

libnmdc_sample.go

@@ -1,4 +1,8 @@
-// nmdc project main.go
+// +build ignore
+
+// This sample file demonstrates use of the libnmdc.go library. It's excluded
+//  when building the library package, but you can run it via `go run libnmdc_sample.go`.
+
 package main
 
 import (
@@ -9,7 +13,7 @@ import (
 func main() {
 
 	opts := libnmdc.HubConnectionOptions{
-		Address: "127.0.0.1:411",
+		Address: "127.0.0.1",
 		Self:    libnmdc.UserInfo{Nick: "slowpoke9"},
 	}
 	hub := opts.Connect()
@@ -18,7 +22,7 @@ func main() {
 		event := <-hub.OnEvent
 		switch event.EventType {
 		case libnmdc.EVENT_CONNECTION_STATE_CHANGED:
-			fmt.Printf("Connection -- %s\n", event.StateChange.Format())
+			fmt.Printf("Connection -- %s (%s)\n", event.StateChange.Format(), event.Message)
 
 		case libnmdc.EVENT_PUBLIC:
 			fmt.Printf("Message from '%s': '%s'\n", event.Nick, event.Message)

src/libnmdc/libnmdc.go

@@ -1,354 +0,0 @@
-// libnmdc project libnmdc.go
-package libnmdc
-
-import (
-	"fmt"
-	"net"
-	"regexp"
-	"strings"
-	"time"
-)
-
-type ConnectionState int
-type HubAddress string
-type HubEventType int
-
-const (
-	CONNECTIONSTATE_DISCONNECTED = 1
-	CONNECTIONSTATE_CONNECTING   = 2 // Handshake in progress
-	CONNECTIONSTATE_CONNECTED    = 3
-)
-
-const (
-	EVENT_PUBLIC                   = 1
-	EVENT_PRIVATE                  = 2
-	EVENT_SYSTEM_MESSAGE_FROM_HUB  = 3
-	EVENT_SYSTEM_MESSAGE_FROM_CONN = 4
-	EVENT_USER_JOINED              = 5
-	EVENT_USER_PART                = 6
-	EVENT_USER_UPDATED_INFO        = 7
-	EVENT_CONNECTION_STATE_CHANGED = 8
-	EVENT_HUBNAME_CHANGED          = 9
-	EVENT_DEBUG_MESSAGE            = 10
-)
-
-var rx_protocolMessage *regexp.Regexp
-var rx_publicChat *regexp.Regexp
-var rx_incomingTo *regexp.Regexp
-
-func init() {
-	rx_protocolMessage = regexp.MustCompile("(?ms)^[^|]*|")
-	rx_publicChat = regexp.MustCompile("(?ms)^<([^>]*)> (.*)$")
-	rx_incomingTo = regexp.MustCompile("(?ms)^([^ ]+) From: ([^ ]+) $<([^>]*)> (.*)$")
-}
-
-type HubConnectionOptions struct {
-	Address           HubAddress
-	Self              UserInfo
-	NickPassword      string
-	NumEventsToBuffer uint
-}
-
-type HubConnection struct {
-	// Supplied parameters
-	Hco *HubConnectionOptions
-
-	// Current remote status
-	HubName string
-	State   ConnectionState
-	Users   map[string]UserInfo
-
-	// Streamed events
-	OnEvent chan HubEvent
-
-	// Private state
-	conn         net.Conn
-	sentOurHello bool
-}
-
-type HubEvent struct {
-	EventType   HubEventType
-	Nick        string
-	Message     string
-	StateChange ConnectionState
-}
-
-func (cs ConnectionState) Format() string {
-	switch cs {
-	case CONNECTIONSTATE_DISCONNECTED:
-		return "Disconnected"
-	case CONNECTIONSTATE_CONNECTING:
-		return "Connecting"
-	case CONNECTIONSTATE_CONNECTED:
-		return "Connected"
-	default:
-		return "?"
-	}
-}
-
-func NMDCUnescape(encoded string) string {
-	v1 := strings.Replace(encoded, "&#36;", "$", -1)
-	v2 := strings.Replace(v1, "&#124;", "|", -1)
-	return strings.Replace(v2, "&amp;", "&", -1)
-}
-
-func NMDCEscape(plaintext string) string {
-	v1 := strings.Replace(plaintext, "&", "&amp;", -1)
-	v2 := strings.Replace(v1, "|", "&#124;", -1)
-	return strings.Replace(v2, "$", "&#36;", -1)
-}
-
-func (this *HubConnection) SayPublic(message string) {
-	this.SayRaw("<" + this.Hco.Self.Nick + "> " + NMDCEscape(message) + "|")
-}
-
-func (this *HubConnection) SayPrivate(recipient string, message string) {
-	this.SayRaw("$To: " + recipient + " From: " + this.Hco.Self.Nick + " $<" + this.Hco.Self.Nick + "> " + NMDCEscape(message) + "|")
-}
-
-func (this *HubConnection) SayInfo() {
-	this.SayRaw(this.Hco.Self.toMyINFO() + "|")
-}
-
-func (this *HubConnection) userJoined_NameOnly(nick string) {
-	_, already_existed := this.Users[nick]
-	if !already_existed {
-		this.Users[nick] = *NewUserInfo(nick)
-		this.OnEvent <- HubEvent{EventType: EVENT_USER_JOINED, Nick: nick}
-	}
-}
-
-func (this *HubConnection) userJoined_Full(uinf *UserInfo) {
-	_, already_existed := this.Users[uinf.Nick]
-	if !already_existed {
-		this.Users[uinf.Nick] = *uinf
-		this.OnEvent <- HubEvent{EventType: EVENT_USER_JOINED, Nick: uinf.Nick}
-	}
-}
-
-// Note that protocol messages are transmitted on the caller thread, not from
-// any internal libnmdc thread.
-func (this *HubConnection) SayRaw(protocolCommand string) error {
-	_, err := this.conn.Write([]byte(protocolCommand))
-	return err
-}
-
-func parseLock(lock []byte) string {
-
-	nibble_swap := func(b byte) byte {
-		return ((b << 4) & 0xF0) | ((b >> 4) & 0x0F)
-	}
-
-	chr := func(b byte) string {
-		if b == 0 || b == 5 || b == 36 || b == 96 || b == 124 || b == 126 {
-			return fmt.Sprintf("/%%DCN%04d%%/", b)
-		} else {
-			return string(b)
-		}
-	}
-
-	key := chr(nibble_swap(lock[0] ^ lock[len(lock)-2] ^ lock[len(lock)-3] ^ 5))
-	for i := 1; i < len(lock); i += 1 {
-		key += chr(nibble_swap(lock[i] ^ lock[i-1]))
-	}
-
-	return key
-}
-
-func (this *HubConnection) processProtocolMessage(message string) {
-
-	// Zero-length protocol message
-	// ````````````````````````````
-	if len(message) == 0 {
-		return
-	}
-
-	// Public chat
-	// ```````````
-	if rx_publicChat.MatchString(message) {
-		pubchat_parts := rx_publicChat.FindStringSubmatch(message)
-		this.OnEvent <- HubEvent{EventType: EVENT_PUBLIC, Nick: pubchat_parts[1], Message: NMDCUnescape(pubchat_parts[2])}
-		return
-	}
-
-	// System messages
-	// ```````````````
-	if message[0] != '$' {
-		this.OnEvent <- HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_HUB, Nick: this.HubName, Message: NMDCUnescape(message)}
-		return
-	}
-
-	// Protocol messages
-	// `````````````````
-
-	commandParts := strings.SplitN(message, " ", 2)
-	switch commandParts[0] {
-
-	case "$Lock":
-		this.SayRaw("$Supports NoGetINFO UserCommand UserIP2|" +
-			"$Key " + parseLock([]byte(commandParts[1])) + "|" +
-			"$ValidateNick " + NMDCEscape(this.Hco.Self.Nick) + "|")
-		this.sentOurHello = false
-
-	case "$Hello":
-		if commandParts[1] == this.Hco.Self.Nick && !this.sentOurHello {
-			this.SayRaw("$Version 1,0091|")
-			this.SayRaw("$GetNickList|")
-			this.SayInfo()
-			this.sentOurHello = true
-
-		} else {
-			this.userJoined_NameOnly(commandParts[1])
-
-		}
-
-	case "$HubName":
-		this.HubName = commandParts[1]
-		this.OnEvent <- HubEvent{EventType: EVENT_HUBNAME_CHANGED, Nick: commandParts[1]}
-
-	case "$ValidateDenide": // sic
-		if len(this.Hco.NickPassword) > 0 {
-			this.OnEvent <- HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_CONN, Message: "Incorrect password."}
-		} else {
-			this.OnEvent <- HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_CONN, Message: "Nick already in use."}
-		}
-
-	case "$HubIsFull":
-		this.OnEvent <- HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_CONN, Message: "Hub is full."}
-
-	case "$BadPass":
-		this.OnEvent <- HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_CONN, Message: "Incorrect password."}
-
-	case "$GetPass":
-		this.SayRaw("$MyPass " + NMDCEscape(this.Hco.NickPassword) + "|")
-
-	case "$Quit":
-		delete(this.Users, commandParts[1])
-		this.OnEvent <- HubEvent{EventType: EVENT_USER_PART, Nick: commandParts[1]}
-
-	case "$MyINFO":
-		u := UserInfo{}
-		err := u.fromMyINFO(commandParts[1])
-		if err == nil {
-			this.userJoined_Full(&u)
-		} else {
-			this.OnEvent <- HubEvent{EventType: EVENT_DEBUG_MESSAGE, Message: err.Error()}
-		}
-
-	case "$NickList":
-		nicklist := strings.Split(commandParts[1], "$$")
-		for _, nick := range nicklist {
-			if len(nick) > 0 {
-				this.userJoined_NameOnly(nick)
-			}
-		}
-
-	case "$To":
-		if rx_incomingTo.MatchString(commandParts[1]) {
-			txparts := rx_incomingTo.FindStringSubmatch(commandParts[1])
-			if txparts[0] == this.Hco.Self.Nick && txparts[1] == txparts[2] {
-				this.OnEvent <- HubEvent{EventType: EVENT_PRIVATE, Nick: txparts[1], Message: txparts[3]}
-				break
-			}
-		}
-		this.OnEvent <- HubEvent{EventType: EVENT_DEBUG_MESSAGE, Message: "Malformed private message '" + commandParts[1] + "'"}
-
-	case "$UserIP":
-		// Final message in PtokaX connection handshake - trigger connection callback.
-		// This might not be the case for other hubsofts, though
-		if this.State != CONNECTIONSTATE_CONNECTED {
-			this.OnEvent <- HubEvent{EventType: EVENT_CONNECTION_STATE_CHANGED, StateChange: CONNECTIONSTATE_CONNECTED}
-			this.State = CONNECTIONSTATE_CONNECTED
-		}
-
-	case "$UserCommand":
-		// TODO
-
-	case "$ForceMove":
-		// TODO
-
-	// IGNORABLE COMMANDS
-	case "$Supports":
-	case "$UserList":
-	case "$OpList":
-	case "$HubTopic":
-	case "$Search":
-	case "$ConnectToMe":
-
-	default:
-		this.OnEvent <- HubEvent{EventType: EVENT_DEBUG_MESSAGE, Message: "Unhandled protocol command '" + commandParts[0] + "'"}
-
-	}
-}
-
-func (this *HubConnection) worker() {
-	var fullBuffer string
-
-	for {
-
-		// If we're not connected, attempt reconnect
-		if this.conn == nil {
-			tmp, err := net.Dial("tcp", string(this.Hco.Address))
-			this.conn = tmp
-			if err == nil {
-				this.OnEvent <- HubEvent{EventType: EVENT_CONNECTION_STATE_CHANGED, StateChange: CONNECTIONSTATE_CONNECTING}
-			}
-		}
-
-		// Read from socket into our local buffer (blocking)
-		readBuff := make([]byte, 4096)
-		nbytes, err := this.conn.Read(readBuff)
-		if nbytes > 0 {
-			fullBuffer += string(readBuff[0:nbytes])
-		}
-
-		// Maybe we disconnected
-		if err != nil {
-			this.OnEvent <- HubEvent{EventType: EVENT_CONNECTION_STATE_CHANGED, StateChange: CONNECTIONSTATE_DISCONNECTED}
-			this.conn = nil
-			time.Sleep(30 * time.Second) // Wait before reconnect
-			continue
-		}
-
-		// Attempt to parse a message block
-		for len(fullBuffer) > 0 {
-			for len(fullBuffer) > 0 && fullBuffer[0] == '|' {
-				fullBuffer = fullBuffer[1:]
-			}
-			protocolMessage := rx_protocolMessage.FindString(fullBuffer)
-			if len(protocolMessage) > 0 {
-				this.processProtocolMessage(string(protocolMessage))
-				fullBuffer = fullBuffer[len(protocolMessage):]
-			} else {
-				break
-			}
-		}
-
-	}
-
-}
-
-// Connects to an NMDC server, and spawns a background goroutine to handle
-//  protocol messages. Client code should select on all the interface channels.
-func (this *HubConnectionOptions) Connect() *HubConnection {
-
-	if this.Self.ClientTag == "" {
-		this.Self.ClientTag = "libnmdc.go"
-	}
-	if this.NumEventsToBuffer < 1 {
-		this.NumEventsToBuffer = 1
-	}
-
-	hc := HubConnection{
-		Hco:          this,
-		HubName:      "(unknown)",
-		State:        CONNECTIONSTATE_DISCONNECTED,
-		Users:        make(map[string]UserInfo),
-		OnEvent:      make(chan HubEvent, this.NumEventsToBuffer),
-		sentOurHello: false,
-	}
-
-	go hc.worker()
-
-	return &hc
-}