mirror/goirc
1
0
Fork 0
mirror of https://github.com/fluffle/goirc synced 2025-05-12 18:44:50 +00:00
Code Issues Releases Wiki Activity

Remove state.StateTracker stutter, hide it in Conn.

Browse source
This commit is contained in:
Alex Bramley 2013-02-16 11:29:56 +00:00
parent a88b866b63
commit 45d7b3317f
7 changed files with 107 additions and 107 deletions
Download patch file Download diff file Expand all files Collapse all files

29
client/connection.go
View file

@ -24,8 +24,7 @@ type Conn struct {
commands *cSet
// State tracker for nicks and channels
ST state.StateTracker
st bool
st state.Tracker
stRemovers []Remover
// Use the State field to store external state that handlers might need.
@ -100,32 +99,34 @@ func Client(nick string, args ...string) *Conn {
}
func (conn *Conn) EnableStateTracking() {
if !conn.st {
if conn.st == nil {
n := conn.Me
conn.ST = state.NewTracker(n.Nick)
conn.Me = conn.ST.Me()
conn.st = state.NewTracker(n.Nick)
conn.Me = conn.st.Me()
conn.Me.Ident = n.Ident
conn.Me.Name = n.Name
conn.addSTHandlers()
conn.st = true
}
}
func (conn *Conn) DisableStateTracking() {
if conn.st {
conn.st = false
if conn.st != nil {
conn.delSTHandlers()
conn.ST.Wipe()
conn.ST = nil
conn.st.Wipe()
conn.st = nil
}
}
func (conn *Conn) StateTracker() state.Tracker {
return conn.st
}
// Per-connection state initialisation.
func (conn *Conn) initialise() {
conn.io = nil
conn.sock = nil
if conn.st {
conn.ST.Wipe()
if conn.st != nil {
conn.st.Wipe()
}
}
@ -328,8 +329,8 @@ func (conn *Conn) String() string {
str += "Not currently connected!\n\n"
}
str += conn.Me.String() + "\n"
if conn.st {
str += conn.ST.String() + "\n"
if conn.st != nil {
str += conn.st.String() + "\n"
}
return str
}

15
client/connection_test.go
View file

@ -12,20 +12,19 @@ import (
type testState struct {
ctrl *gomock.Controller
st *state.MockStateTracker
st *state.MockTracker
nc *mockNetConn
c *Conn
}
func setUp(t *testing.T, start ...bool) (*Conn, *testState) {
ctrl := gomock.NewController(t)
st := state.NewMockStateTracker(ctrl)
st := state.NewMockTracker(ctrl)
nc := MockNetConn(t)
c := Client("test", "test", "Testing IRC")
logging.SetLogLevel(logging.LogFatal)
c.ST = st
c.st = true
c.st = st
c.sock = nc
c.Flood = true // Tests can take a while otherwise
c.Connected = true
@ -82,7 +81,7 @@ func TestEOF(t *testing.T) {
func TestClientAndStateTracking(t *testing.T) {
ctrl := gomock.NewController(t)
st := state.NewMockStateTracker(ctrl)
st := state.NewMockTracker(ctrl)
c := Client("test", "test", "Testing IRC")
// Assert some basic things about the initial state of the Conn struct
@ -114,16 +113,16 @@ func TestClientAndStateTracking(t *testing.T) {
c.Me.Name != "Testing IRC" || c.Me.Host != "" {
t.Errorf("Enabling state tracking did not replace Me correctly.")
}
if !c.st || c.ST == nil || c.Me != c.ST.Me() {
if c.st == nil || c.Me != c.st.Me() {
t.Errorf("State tracker not enabled correctly.")
}
// Now, shim in the mock state tracker and test disabling state tracking
me := c.Me
c.ST = st
c.st = st
st.EXPECT().Wipe()
c.DisableStateTracking()
if c.st || c.ST != nil || c.Me != me {
if c.st != nil || c.Me != me {
t.Errorf("State tracker not disabled correctly.")
}

6
client/handlers.go
View file

@ -60,8 +60,8 @@ func (conn *Conn) h_433(line *Line) {
// we sent in the initial NICK command is in use) we will not receive
// a NICK message to confirm our change of nick, so ReNick here...
if line.Args[1] == conn.Me.Nick {
if conn.st {
conn.ST.ReNick(conn.Me.Nick, neu)
if conn.st != nil {
conn.st.ReNick(conn.Me.Nick, neu)
} else {
conn.Me.Nick = neu
}
@ -79,7 +79,7 @@ func (conn *Conn) h_CTCP(line *Line) {
// Handle updating our own NICK if we're not using the state tracker
func (conn *Conn) h_NICK(line *Line) {
if !conn.st && line.Nick == conn.Me.Nick {
if conn.st == nil && line.Nick == conn.Me.Nick {
conn.Me.Nick = line.Args[0]
}
}

8
client/handlers_test.go
View file

@ -74,14 +74,14 @@ func Test433(t *testing.T) {
}
// Test the code path that *doesn't* involve state tracking.
c.st = false
c.st = nil
c.h_433(parseLine(":irc.server.org 433 test test :Nickname is already in use."))
s.nc.Expect("NICK test_")
if c.Me.Nick != "test_" {
t.Errorf("My nick not updated from '%s'.", c.Me.Nick)
}
c.st = true
c.st = s.st
}
// Test the handler for NICK messages when state tracking is disabled
@ -90,7 +90,7 @@ func TestNICK(t *testing.T) {
defer s.tearDown()
// State tracking is enabled by default in setUp
c.st = false
c.st = nil
// Call handler with a NICK line changing "our" nick to test1.
c.h_NICK(parseLine(":test!test@somehost.com NICK :test1"))
@ -109,7 +109,7 @@ func TestNICK(t *testing.T) {
}
// Re-enable state tracking and send a line that *should* change nick.
c.st = true
c.st = s.st
c.h_NICK(parseLine(":test1!test@somehost.com NICK :test2"))
// Verify that our Nick hasn't changed (should be handled by h_STNICK).

48
client/state_handlers.go
View file

@ -40,13 +40,13 @@ func (conn *Conn) delSTHandlers() {
// Handle NICK messages that need to update the state tracker
func (conn *Conn) h_STNICK(line *Line) {
// all nicks should be handled the same way, our own included
conn.ST.ReNick(line.Nick, line.Args[0])
conn.st.ReNick(line.Nick, line.Args[0])
}
// Handle JOINs to channels to maintain state
func (conn *Conn) h_JOIN(line *Line) {
ch := conn.ST.GetChannel(line.Args[0])
nk := conn.ST.GetNick(line.Nick)
ch := conn.st.GetChannel(line.Args[0])
nk := conn.st.GetNick(line.Nick)
if ch == nil {
// first we've seen of this channel, so should be us joining it
// NOTE this will also take care of nk == nil && ch == nil
@ -55,7 +55,7 @@ func (conn *Conn) h_JOIN(line *Line) {
"from (non-me) nick %s", line.Args[0], line.Nick)
return
}
ch = conn.ST.NewChannel(line.Args[0])
ch = conn.st.NewChannel(line.Args[0])
// since we don't know much about this channel, ask server for info
// we get the channel users automatically in 353 and the channel
// topic in 332 on join, so we just need to get the modes
@ -66,41 +66,41 @@ func (conn *Conn) h_JOIN(line *Line) {
}
if nk == nil {
// this is the first we've seen of this nick
nk = conn.ST.NewNick(line.Nick)
nk = conn.st.NewNick(line.Nick)
nk.Ident = line.Ident
nk.Host = line.Host
// since we don't know much about this nick, ask server for info
conn.Who(nk.Nick)
}
// this takes care of both nick and channel linking \o/
conn.ST.Associate(ch, nk)
conn.st.Associate(ch, nk)
}
// Handle PARTs from channels to maintain state
func (conn *Conn) h_PART(line *Line) {
conn.ST.Dissociate(conn.ST.GetChannel(line.Args[0]),
conn.ST.GetNick(line.Nick))
conn.st.Dissociate(conn.st.GetChannel(line.Args[0]),
conn.st.GetNick(line.Nick))
}
// Handle KICKs from channels to maintain state
func (conn *Conn) h_KICK(line *Line) {
// XXX: this won't handle autorejoining channels on KICK
// it's trivial to do this in a seperate handler...
conn.ST.Dissociate(conn.ST.GetChannel(line.Args[0]),
conn.ST.GetNick(line.Args[1]))
conn.st.Dissociate(conn.st.GetChannel(line.Args[0]),
conn.st.GetNick(line.Args[1]))
}
// Handle other people's QUITs
func (conn *Conn) h_QUIT(line *Line) {
conn.ST.DelNick(line.Nick)
conn.st.DelNick(line.Nick)
}
// Handle MODE changes for channels we know about (and our nick personally)
func (conn *Conn) h_MODE(line *Line) {
if ch := conn.ST.GetChannel(line.Args[0]); ch != nil {
if ch := conn.st.GetChannel(line.Args[0]); ch != nil {
// channel modes first
ch.ParseModes(line.Args[1], line.Args[2:]...)
} else if nk := conn.ST.GetNick(line.Args[0]); nk != nil {
} else if nk := conn.st.GetNick(line.Args[0]); nk != nil {
// nick mode change, should be us
if nk != conn.Me {
logging.Warn("irc.MODE(): recieved MODE %s for (non-me) nick %s",
@ -116,7 +116,7 @@ func (conn *Conn) h_MODE(line *Line) {
// Handle TOPIC changes for channels
func (conn *Conn) h_TOPIC(line *Line) {
if ch := conn.ST.GetChannel(line.Args[0]); ch != nil {
if ch := conn.st.GetChannel(line.Args[0]); ch != nil {
ch.Topic = line.Args[1]
} else {
logging.Warn("irc.TOPIC(): topic change on unknown channel %s",
@ -126,7 +126,7 @@ func (conn *Conn) h_TOPIC(line *Line) {
// Handle 311 whois reply
func (conn *Conn) h_311(line *Line) {
if nk := conn.ST.GetNick(line.Args[1]); nk != nil {
if nk := conn.st.GetNick(line.Args[1]); nk != nil {
nk.Ident = line.Args[2]
nk.Host = line.Args[3]
nk.Name = line.Args[5]
@ -138,7 +138,7 @@ func (conn *Conn) h_311(line *Line) {
// Handle 324 mode reply
func (conn *Conn) h_324(line *Line) {
if ch := conn.ST.GetChannel(line.Args[1]); ch != nil {
if ch := conn.st.GetChannel(line.Args[1]); ch != nil {
ch.ParseModes(line.Args[2], line.Args[3:]...)
} else {
logging.Warn("irc.324(): received MODE settings for unknown channel %s",
@ -148,7 +148,7 @@ func (conn *Conn) h_324(line *Line) {
// Handle 332 topic reply on join to channel
func (conn *Conn) h_332(line *Line) {
if ch := conn.ST.GetChannel(line.Args[1]); ch != nil {
if ch := conn.st.GetChannel(line.Args[1]); ch != nil {
ch.Topic = line.Args[2]
} else {
logging.Warn("irc.332(): received TOPIC value for unknown channel %s",
@ -158,7 +158,7 @@ func (conn *Conn) h_332(line *Line) {
// Handle 352 who reply
func (conn *Conn) h_352(line *Line) {
if nk := conn.ST.GetNick(line.Args[5]); nk != nil {
if nk := conn.st.GetNick(line.Args[5]); nk != nil {
nk.Ident = line.Args[2]
nk.Host = line.Args[3]
// XXX: do we care about the actual server the nick is on?
@ -180,7 +180,7 @@ func (conn *Conn) h_352(line *Line) {
// Handle 353 names reply
func (conn *Conn) h_353(line *Line) {
if ch := conn.ST.GetChannel(line.Args[2]); ch != nil {
if ch := conn.st.GetChannel(line.Args[2]); ch != nil {
nicks := strings.Split(line.Args[len(line.Args)-1], " ")
for _, nick := range nicks {
// UnrealIRCd's coders are lazy and leave a trailing space
@ -192,15 +192,15 @@ func (conn *Conn) h_353(line *Line) {
nick = nick[1:]
fallthrough
default:
nk := conn.ST.GetNick(nick)
nk := conn.st.GetNick(nick)
if nk == nil {
// we don't know this nick yet!
nk = conn.ST.NewNick(nick)
nk = conn.st.NewNick(nick)
}
cp, ok := conn.ST.IsOn(ch.Name, nick)
cp, ok := conn.st.IsOn(ch.Name, nick)
if !ok {
// This nick isn't associated with this channel yet!
cp = conn.ST.Associate(ch, nk)
cp = conn.st.Associate(ch, nk)
}
switch c {
case '~':
@ -224,7 +224,7 @@ func (conn *Conn) h_353(line *Line) {
// Handle 671 whois reply (nick connected via SSL)
func (conn *Conn) h_671(line *Line) {
if nk := conn.ST.GetNick(line.Args[1]); nk != nil {
if nk := conn.st.GetNick(line.Args[1]); nk != nil {
nk.Modes.SSL = true
} else {
logging.Warn("irc.671(): received WHOIS SSL info for unknown nick %s",