readme

.hgtags

@@ -12,3 +12,5 @@ cb86f3a40115cc46f450c0c83fd9b9d3b740e820 libnmdc-r6
 71343a2c641a438206d30ea7e75dc89a11dbef00 libnmdc-r7
 b0e57a5fcffdf4102d669db51a3648ddf66a0792 libnmdc-r8
 e7c2c71ef24b386add728fad35fff4a996fccbac libnmdc-r9
+3ecc037cf2d7080572fe87c2e39ecd153fb0e947 libnmdc-r10
+5149ffe70ea8475e480b682345b31aa45a3352db release-0.11

ConnectionMode.go

@@ -0,0 +1,29 @@
+package libnmdc
+
+import (
+	"fmt"
+)
+
+type ConnectionMode rune
+
+const (
+	CONNECTIONMODE_ACTIVE  ConnectionMode = 'A' // 65
+	CONNECTIONMODE_PASSIVE ConnectionMode = 'P' // 49
+	CONNECTIONMODE_SOCKS5  ConnectionMode = '5' // 53
+)
+
+func (this ConnectionMode) String() string {
+	switch this {
+	case CONNECTIONMODE_ACTIVE:
+		return "Active"
+
+	case CONNECTIONMODE_PASSIVE:
+		return "Passive"
+
+	case CONNECTIONMODE_SOCKS5:
+		return "SOCKS5"
+
+	default:
+		return fmt.Sprintf("ConnectionMode(\"%s\")", string(this))
+	}
+}

ConnectionState.go

@@ -12,7 +12,7 @@ const (
 	CONNECTIONSTATE_CONNECTED    = 3
 )
 
-func (cs ConnectionState) Format() string {
+func (cs ConnectionState) String() string {
 	switch cs {
 	case CONNECTIONSTATE_DISCONNECTED:
 		return "Disconnected"
@@ -25,7 +25,7 @@ func (cs ConnectionState) Format() string {
 	}
 }
 
-func CheckIsNetTimeout(err error) bool {
+func checkIsNetTimeout(err error) bool {
 	if err == nil {
 		return false
 	}

Example_test.go

@@ -0,0 +1,58 @@
+package libnmdc
+
+import (
+	"fmt"
+)
+
+func ExampleHubConnectionOptions_Connect() {
+	opts := HubConnectionOptions{
+		Address: "127.0.0.1",
+		Self:    *NewUserInfo("slowpoke9"),
+	}
+	hub := opts.Connect()
+
+	for {
+		event := <-hub.OnEvent
+		switch event.EventType {
+		case EVENT_CONNECTION_STATE_CHANGED:
+			fmt.Printf("Connection -- %s (%s)\n", event.StateChange.Format(), event.Message)
+
+		case EVENT_PUBLIC:
+			fmt.Printf("Message from '%s': '%s'\n", event.Nick, event.Message)
+			if event.Message == "how are you" {
+				hub.SayPublic("good thanks!")
+			}
+
+		default:
+			fmt.Printf("%+v\n", event)
+
+		}
+	}
+}
+
+func ExampleHubConnectionOptions_ConnectSync() {
+	cb := func(hub *HubConnection, event HubEvent) {
+		switch event.EventType {
+		case EVENT_CONNECTION_STATE_CHANGED:
+			fmt.Printf("Connection -- %s (%s)\n", event.StateChange.Format(), event.Message)
+
+		case EVENT_PUBLIC:
+			fmt.Printf("Message from '%s': '%s'\n", event.Nick, event.Message)
+			if event.Message == "how are you" {
+				hub.SayPublic("good thanks!")
+			}
+
+		default:
+			fmt.Printf("%+v\n", event)
+
+		}
+	}
+
+	opts := HubConnectionOptions{
+		Address:     "127.0.0.1",
+		Self:        *NewUserInfo("slowpoke9"),
+		OnEventSync: cb,
+	}
+
+	opts.ConnectSync() // blocking
+}

HubConnection.go

@@ -30,6 +30,7 @@ type HubConnection struct {
 	autoReconnect bool
 }
 
+// Thread-safe user accessor.
 func (this *HubConnection) Users(cb func(*map[string]UserInfo) error) error {
 	this.userLock.Lock()
 	defer this.userLock.Unlock()
@@ -38,11 +39,11 @@ func (this *HubConnection) Users(cb func(*map[string]UserInfo) error) error {
 }
 
 func (this *HubConnection) SayPublic(message string) {
-	this.SayRaw("<" + this.Hco.Self.Nick + "> " + NMDCEscape(message) + "|")
+	this.SayRaw("<" + this.Hco.Self.Nick + "> " + Escape(message) + "|")
 }
 
 func (this *HubConnection) SayPrivate(recipient string, message string) {
-	this.SayRaw("$To: " + recipient + " From: " + this.Hco.Self.Nick + " $<" + this.Hco.Self.Nick + "> " + NMDCEscape(message) + "|")
+	this.SayRaw("$To: " + recipient + " From: " + this.Hco.Self.Nick + " $<" + this.Hco.Self.Nick + "> " + Escape(message) + "|")
 }
 
 func (this *HubConnection) SayInfo() {
@@ -66,10 +67,11 @@ func (this *HubConnection) UserCount() int {
 
 func (this *HubConnection) userJoined_NameOnly(nick string) {
 	if !this.UserExists(nick) {
-		this.userLock.Lock()
-		defer this.userLock.Unlock()
 
+		this.userLock.Lock()
 		this.users[nick] = *NewUserInfo(nick)
+		this.userLock.Unlock() // Don't lock over a processEvent boundary
+
 		this.processEvent(HubEvent{EventType: EVENT_USER_JOINED, Nick: nick})
 	}
 }
@@ -77,17 +79,17 @@ func (this *HubConnection) userJoined_NameOnly(nick string) {
 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
+	this.userLock.Unlock() // Don't lock over a processEvent boundary
 
 	if !userExisted {
 		this.processEvent(HubEvent{EventType: EVENT_USER_JOINED, Nick: uinf.Nick})
 	}
 }
 
+// SayRaw sends raw bytes over the TCP socket. Callers should add the protocol
+// terminating character `|` themselves.
 // Note that protocol messages are transmitted on the caller thread, not from
 // any internal libnmdc thread.
 func (this *HubConnection) SayRaw(protocolCommand string) error {
@@ -111,14 +113,14 @@ func (this *HubConnection) processProtocolMessage(message string) {
 	// ```````````
 	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])})
+		this.processEvent(HubEvent{EventType: EVENT_PUBLIC, Nick: pubchat_parts[1], Message: Unescape(pubchat_parts[2])})
 		return
 	}
 
 	// System messages
 	// ```````````````
 	if message[0] != '$' {
-		this.processEvent(HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_HUB, Nick: this.HubName, Message: NMDCUnescape(message)})
+		this.processEvent(HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_HUB, Nick: this.HubName, Message: Unescape(message)})
 		return
 	}
 
@@ -130,8 +132,8 @@ func (this *HubConnection) processProtocolMessage(message string) {
 
 	case "$Lock":
 		this.SayRaw("$Supports NoGetINFO UserCommand UserIP2|" +
-			"$Key " + NMDCUnlock([]byte(commandParts[1])) + "|" +
+			"$Key " + unlock([]byte(commandParts[1])) + "|" +
-			"$ValidateNick " + NMDCEscape(this.Hco.Self.Nick) + "|")
+			"$ValidateNick " + Escape(this.Hco.Self.Nick) + "|")
 		this.sentOurHello = false
 
 	case "$Hello":
@@ -164,15 +166,20 @@ func (this *HubConnection) processProtocolMessage(message string) {
 		this.processEvent(HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_CONN, Message: "Incorrect password."})
 
 	case "$GetPass":
-		this.SayRaw("$MyPass " + NMDCEscape(this.Hco.NickPassword) + "|")
+		if len(this.Hco.NickPassword) == 0 {
+			// We've got a problem. MyPass with no arguments is a syntax error with no message = instant close
+			// Just drop the connection
+			this.processEvent(HubEvent{EventType: EVENT_SYSTEM_MESSAGE_FROM_CONN, Message: "This account is passworded."})
+			this.Disconnect()
+		} else {
+			this.SayRaw("$MyPass " + Escape(this.Hco.NickPassword) + "|")
+		}
 
 	case "$Quit":
-		func() {
 		this.userLock.Lock()
-			defer this.userLock.Unlock()
-
 		delete(this.users, commandParts[1])
-		}()
+		this.userLock.Unlock() // Don't lock over a processEvent boundary
+
 		this.processEvent(HubEvent{EventType: EVENT_USER_PART, Nick: commandParts[1]})
 
 	case "$MyINFO":
@@ -224,7 +231,7 @@ func (this *HubConnection) processProtocolMessage(message string) {
 		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]})
+				this.processEvent(HubEvent{EventType: EVENT_PRIVATE, Nick: txparts[2], Message: Unescape(txparts[4])})
 				valid = true
 			}
 		}
@@ -257,7 +264,7 @@ func (this *HubConnection) processProtocolMessage(message string) {
 				Type:    UserCommandType(typeInt),
 				Context: UserCommandContext(contextInt),
 				Message: usc[3],
-				Command: NMDCUnescape(usc[4]),
+				Command: Unescape(usc[4]),
 			}
 
 			this.processEvent(HubEvent{EventType: EVENT_USERCOMMAND, UserCommand: &uscStruct})
@@ -324,7 +331,7 @@ func (this *HubConnection) worker() {
 			this.conn.SetReadDeadline(time.Now().Add(SEND_KEEPALIVE_EVERY))
 			nbytes, err = this.conn.Read(readBuff)
 
-			if CheckIsNetTimeout(err) {
+			if checkIsNetTimeout(err) {
 				// No data before read deadline
 				err = nil
 

HubConnectionOptions.go

@@ -11,12 +11,18 @@ type HubConnectionOptions struct {
 	NumEventsToBuffer uint
 
 	// Returning messages in sync mode
-	OnEventSync func(HubEvent)
+	OnEventSync func(*HubConnection, HubEvent)
 }
 
 func (this *HubConnectionOptions) prepareConnection() *HubConnection {
 	if this.Self.ClientTag == "" {
 		this.Self.ClientTag = DEFAULT_CLIENT_TAG
+		this.Self.ClientVersion = DEFAULT_CLIENT_VERSION
+	}
+
+	// Shouldn't be blank either
+	if this.Self.ClientVersion == "" {
+		this.Self.ClientVersion = "0"
 	}
 
 	hc := HubConnection{
@@ -54,5 +60,9 @@ func (this *HubConnectionOptions) Connect() *HubConnection {
 // Client code should supply an event handling function as hco.OnEventSync.
 func (this *HubConnectionOptions) ConnectSync() {
 	hc := this.prepareConnection()
+	hc.OnEvent = nil
+	hc.processEvent = func(ev HubEvent) {
+		this.OnEventSync(hc, ev)
+	}
 	hc.worker()
 }

UserFlag.go

@@ -0,0 +1,17 @@
+package libnmdc
+
+type UserFlag byte
+
+const (
+	FLAG_NORMAL          UserFlag = 1
+	FLAG_AWAY_1          UserFlag = 2
+	FLAG_AWAY_2          UserFlag = 3
+	FLAG_SERVER_1        UserFlag = 4
+	FLAG_SERVER_2        UserFlag = 5
+	FLAG_SERVER_AWAY_1   UserFlag = 6
+	FLAG_SERVER_AWAY_2   UserFlag = 7
+	FLAG_FIREBALL_1      UserFlag = 8
+	FLAG_FIREBALL_2      UserFlag = 9
+	FLAG_FIREBALL_AWAY_1 UserFlag = 10
+	FLAG_FIREBALL_AWAY_2 UserFlag = 11
+)

UserInfo.go

@@ -1,4 +1,3 @@
-// libnmdc project UserInfo.go
 package libnmdc
 
 import (
@@ -9,30 +8,6 @@ import (
 	"strings"
 )
 
-type UserFlag byte
-
-const (
-	FLAG_NORMAL          UserFlag = 1
-	FLAG_AWAY_1          UserFlag = 2
-	FLAG_AWAY_2          UserFlag = 3
-	FLAG_SERVER_1        UserFlag = 4
-	FLAG_SERVER_2        UserFlag = 5
-	FLAG_SERVER_AWAY_1   UserFlag = 6
-	FLAG_SERVER_AWAY_2   UserFlag = 7
-	FLAG_FIREBALL_1      UserFlag = 8
-	FLAG_FIREBALL_2      UserFlag = 9
-	FLAG_FIREBALL_AWAY_1 UserFlag = 10
-	FLAG_FIREBALL_AWAY_2 UserFlag = 11
-)
-
-type ConnectionMode rune
-
-const (
-	CONNECTIONMODE_ACTIVE  ConnectionMode = 'A'
-	CONNECTIONMODE_PASSIVE ConnectionMode = 'P'
-	CONNECTIONMODE_SOCKS5  ConnectionMode = '5'
-)
-
 // This structure represents a user connected to a hub.
 type UserInfo struct {
 	Nick             string
@@ -55,31 +30,13 @@ var rx_myinfo *regexp.Regexp
 var rx_myinfo_notag *regexp.Regexp
 
 func init() {
-	// $ALL <nick> <description>$ $<connection><flag>$<e-mail>$<sharesize>$
+	// Format: $ALL <nick> <description>$ $<connection><flag>$<e-mail>$<sharesize>$
 
 	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 := ""
-		// 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)
-		if err != nil {
-			fmt.Println(err.Error())
-		} else {
-			fmt.Printf("%+v\n", u)
-		}
-
-		panic("")
-	*/
 }
 
 func NewUserInfo(username string) *UserInfo {
@@ -105,10 +62,10 @@ func (this *UserInfo) fromMyINFO(protomsg string) error {
 	matches := rx_myinfo.FindStringSubmatch(protomsg)
 	if matches != nil {
 		this.Nick = matches[1]
-		this.Description = NMDCUnescape(matches[2])
+		this.Description = Unescape(matches[2])
-		this.ClientTag = NMDCUnescape(matches[3])
+		this.ClientTag = Unescape(matches[3])
 		this.ClientVersion = matches[4]
-		this.ConnectionMode = ConnectionMode(matches[4][0])
+		this.ConnectionMode = ConnectionMode(matches[5][0])
 		maybeParse(matches[6], &this.HubsUnregistered, 0)
 		maybeParse(matches[7], &this.HubsRegistered, 0)
 		maybeParse(matches[8], &this.HubsOperator, 0)
@@ -119,7 +76,7 @@ func (this *UserInfo) fromMyINFO(protomsg string) error {
 			this.Speed = ""
 		}
 		this.Flag = UserFlag(matches[10][len(matches[10])-1])
-		this.Email = NMDCUnescape(matches[11])
+		this.Email = Unescape(matches[11])
 		maybeParse(matches[12], &this.ShareSize, 0)
 
 		return nil
@@ -129,7 +86,7 @@ func (this *UserInfo) fromMyINFO(protomsg string) error {
 	matches = rx_myinfo_notag.FindStringSubmatch(protomsg)
 	if matches != nil {
 		this.Nick = matches[1]
-		this.Description = NMDCUnescape(matches[2])
+		this.Description = Unescape(matches[2])
 		this.ClientTag = ""
 		this.ClientVersion = "0"
 		this.ConnectionMode = CONNECTIONMODE_PASSIVE
@@ -144,14 +101,12 @@ func (this *UserInfo) fromMyINFO(protomsg string) error {
 			this.Speed = ""
 		}
 		this.Flag = UserFlag(matches[3][len(matches[3])-1])
-		this.Email = NMDCUnescape(matches[4])
+		this.Email = Unescape(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")
 }

UserInfo_test.go

@@ -0,0 +1,88 @@
+package libnmdc
+
+import (
+	"testing"
+)
+
+type myInfoTestPair struct {
+	in     string
+	expect UserInfo
+}
+
+func TestMyINFOParse(t *testing.T) {
+
+	cases := []myInfoTestPair{
+
+		myInfoTestPair{
+			in: "$ALL Bxxxy description<ApexDC++ V:1.4.3,M:P,H:9/0/2,S:1>$ $0.01\x01$xyz@example.com$53054999578$",
+			expect: UserInfo{
+				Nick:             "Bxxxy",
+				Description:      "description",
+				ClientTag:        "ApexDC++",
+				ClientVersion:    "1.4.3",
+				Email:            "xyz@example.com",
+				ShareSize:        53054999578,
+				ConnectionMode:   CONNECTIONMODE_PASSIVE,
+				Flag:             FLAG_NORMAL,
+				Slots:            1,
+				Speed:            "0.0",
+				HubsUnregistered: 9,
+				HubsRegistered:   0,
+				HubsOperator:     2,
+			},
+		},
+		myInfoTestPair{
+			in: "$ALL ixxxxxxx0 $P$10A$$0$",
+			expect: UserInfo{
+				Nick:           "ixxxxxxx0",
+				ClientVersion:  "0", // Auto-inserted by the parser for short-format MyINFO strings
+				ConnectionMode: CONNECTIONMODE_PASSIVE,
+				Flag:           UserFlag(rune('A')),
+				Speed:          "1",
+			},
+		},
+		myInfoTestPair{
+			in: "$ALL SXXXX_XXXXXXR <ncdc V:1.19.1-12-g5561,M:P,H:1/0/0,S:10>$ $0.005Q$$0$",
+			expect: UserInfo{
+				Nick:             "SXXXX_XXXXXXR",
+				ClientTag:        "ncdc",
+				ClientVersion:    "1.19.1-12-g5561",
+				ConnectionMode:   CONNECTIONMODE_PASSIVE,
+				Flag:             UserFlag(rune('Q')),
+				Slots:            10,
+				Speed:            "0.00",
+				HubsUnregistered: 1,
+			},
+		},
+		myInfoTestPair{
+			in: "$ALL mxxxu desccccc<HexChat V:2.12.1,M:P,H:1/0/0,S:0>$ $p$$0$",
+			expect: UserInfo{
+				Nick:             "mxxxu",
+				Description:      "desccccc",
+				ClientTag:        "HexChat",
+				ClientVersion:    "2.12.1",
+				ConnectionMode:   CONNECTIONMODE_PASSIVE,
+				Flag:             UserFlag(rune('p')),
+				HubsUnregistered: 1,
+				Slots:            0,
+			},
+		},
+	}
+
+	for _, v := range cases {
+
+		got := UserInfo{}
+		err := got.fromMyINFO(v.in)
+
+		if err != nil {
+			t.Errorf("MyINFO parse warning (%s)", err.Error())
+			continue
+		}
+
+		if got != v.expect {
+			t.Errorf("MyINFO parse failure\nExpected:\n%+v\nGot:\n%+v\n", v.expect, got)
+			continue
+		}
+	}
+
+}

__dist/README.txt

@@ -9,6 +9,18 @@ Tags: nmdc
 
 =CHANGELOG=
 
+2017-02-05 0.12
+- Fix an issue with mutex deadlock when accessing user information from a callback
+- Fix an issue with silent disconnection if a password was required but not present
+
+2016-11-29 0.11
+- BREAKING: Remove some exported methods
+- BREAKING: Fix an issue with missing sufficient parameters in the synchronous API
+- Enhancement: Improve output under godoc
+- Fix an issue with special characters appearing in recieved private messages
+- Fix an issue with parsing active/passive connection modes
+- Fix an issue with errors appearing on stdout
+
 2016-10-08 r10
 - Feature: Support `$UserCommand`
 

libnmdc.go

@@ -1,4 +1,3 @@
-// libnmdc project libnmdc.go
 package libnmdc
 
 import (
@@ -11,6 +10,7 @@ import (
 
 const (
 	DEFAULT_CLIENT_TAG     string        = "libnmdc.go"
+	DEFAULT_CLIENT_VERSION string        = "0.11"
 	DEFAULT_HUB_NAME       string        = "(unknown)"
 	SEND_KEEPALIVE_EVERY   time.Duration = 29 * time.Second
 	AUTO_RECONNECT_AFTER   time.Duration = 30 * time.Second
@@ -29,19 +29,19 @@ func init() {
 	rx_userCommand = regexp.MustCompile(`(?ms)^(\d+) (\d+)\s?([^\$]*)\$?(.*)`)
 }
 
-func NMDCUnescape(encoded string) string {
+func Unescape(encoded string) string {
 	v1 := strings.Replace(encoded, "$", "$", -1)
 	v2 := strings.Replace(v1, "|", "|", -1)
 	return strings.Replace(v2, "&", "&", -1)
 }
 
-func NMDCEscape(plaintext string) string {
+func Escape(plaintext string) string {
 	v1 := strings.Replace(plaintext, "&", "&", -1)
 	v2 := strings.Replace(v1, "|", "|", -1)
 	return strings.Replace(v2, "$", "$", -1)
 }
 
-func NMDCUnlock(lock []byte) string {
+func unlock(lock []byte) string {
 
 	nibble_swap := func(b byte) byte {
 		return ((b << 4) & 0xF0) | ((b >> 4) & 0x0F)

libnmdc_sample.go

@@ -1,38 +0,0 @@
-// +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 (
-	"fmt"
-	"libnmdc"
-)
-
-func main() {
-
-	opts := libnmdc.HubConnectionOptions{
-		Address: "127.0.0.1",
-		Self:    libnmdc.UserInfo{Nick: "slowpoke9"},
-	}
-	hub := opts.Connect()
-
-	for {
-		event := <-hub.OnEvent
-		switch event.EventType {
-		case libnmdc.EVENT_CONNECTION_STATE_CHANGED:
-			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)
-			if event.Message == "how are you" {
-				hub.SayPublic("good thanks!")
-			}
-
-		default:
-			fmt.Printf("%+v\n", event)
-
-		}
-	}
-}