-
Notifications
You must be signed in to change notification settings - Fork 1
/
scraper.go
240 lines (206 loc) · 6.24 KB
/
scraper.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
package twitchchatscraper
import (
// "crypto/tls"
"bufio"
"fmt"
"os"
"sync"
"time"
"github.com/sorcix/irc"
log "github.com/cihub/seelog"
)
const (
IRC_PASS_STRING = "PASS %s"
IRC_USER_STRING = "NICK %s"
IRC_JOIN_STRING = "JOIN #%s"
IRC_PART_STRING = "PART #%s"
TWITCH_CHAT_SERVER_ADDRESS = "irc.twitch.tv:6667"
TIME_TO_WAIT_FOR_CONNECTION = time.Second * 5
TIME_BETWEEN_CHANNEL_SCRAPES = time.Minute * 20
CHANNELS_TO_GET_PER_SCRAPE = 1000
)
type Scraper struct {
chatServers *[]string
conn *irc.Conn
reader *irc.Decoder
writer *irc.Encoder
readChan chan *irc.Message
writeChan chan *string
clientChan chan *string
SubscribedTo map[string]bool
connected bool
blacklistedChannels map[string]bool
blacklistMutex *sync.Mutex
}
func NewScraper() *Scraper {
newScraper := Scraper{}
newScraper.SubscribedTo = make(map[string]bool, 0)
newScraper.blacklistMutex = &sync.Mutex{}
return &newScraper
}
func (s *Scraper) Connect() (chan<- *string, <-chan *irc.Message) {
log.Debug("Connecting to Twitch IRC")
// Connect to twitch chat
var err error
s.conn, err = irc.Dial(TWITCH_CHAT_SERVER_ADDRESS)
if err != nil {
log.Errorf("An error occurred whilst connecting to twitch chat, %s.", err.Error())
panic(err)
}
log.Debug("Connection established.")
// Create the IRC communication channels
s.writer = &s.conn.Encoder
s.reader = &s.conn.Decoder
readChannel := make(chan *irc.Message, 100)
writeChannel := make(chan *string, 10)
clientChannel := make(chan *string, 10000)
s.readChan = readChannel
s.writeChan = writeChannel
s.clientChan = clientChannel
go s.Read(readChannel)
go s.Write(writeChannel)
// Authenticate with the server
authString := fmt.Sprintf(IRC_PASS_STRING, Configuration.TwitchOAuthToken)
nickString := fmt.Sprintf(IRC_USER_STRING, Configuration.TwitchUsername)
s.writeChan <- &authString
s.writeChan <- &nickString
// Timeout after a certain amount of time waiting for confirmation
timer := time.NewTimer(TIME_TO_WAIT_FOR_CONNECTION)
connectedNotification := make(chan bool, 1)
go func() {
for !s.connected {
}
connectedNotification <- true
}()
select {
case <-timer.C:
log.Critical("Timeout whilst authenticating with Twitch chat")
panic("Timeout whilst authenticating with Twitch chat")
case <-connectedNotification:
log.Debug("Successfully authenticated with Twitch chat")
}
// Assuming we've successfully authenticated - we can start subscribing to
// chats, and return the channels for use
go s.listenForNewClients()
return clientChannel, readChannel
}
func (s *Scraper) listenForNewClients() {
for {
channelToSubscribeTo := <-s.clientChan
log.Debugf("Asked to subscribe to: %s", *channelToSubscribeTo)
s.blacklistMutex.Lock()
if s.SubscribedTo[*channelToSubscribeTo] {
// No need to worry about rate limit if we're already subscribed
log.Debugf("We're already subscribed to %s", *channelToSubscribeTo)
} else if s.blacklistedChannels[*channelToSubscribeTo] {
// This channel is on the blacklist
log.Debugf("We've been asked not to join %s", *channelToSubscribeTo)
} else {
s.SubscribedTo[*channelToSubscribeTo] = true
joinString := fmt.Sprintf(IRC_JOIN_STRING, *channelToSubscribeTo)
s.writeChan <- &joinString
time.Sleep(time.Second * 2) // We don't want to get rate limited
}
s.blacklistMutex.Unlock()
}
}
func (s *Scraper) Read(givenChan chan<- *irc.Message) {
pongString := "PONG tmi.twitch.tv"
for {
msg, err := s.reader.Decode()
if msg == nil {
log.Errorf("Nil/deformed message %s", msg)
break
} else if msg.Command == "PING" {
log.Debug("Replying to ping")
s.writeChan <- &pongString
} else if msg.Command == "001" {
log.Debugf("IRC RPL_WELCOME received")
s.connected = true
} else if msg.Command != "PRIVMSG" {
log.Debugf("Control message received: %s", msg)
} else if err != nil {
log.Errorf("Error received whilst reading message: %s", err.Error())
break
} else {
// We only care about user messages
if !msg.IsServer() {
givenChan <- msg
}
}
}
}
func (s *Scraper) Write(givenChan <-chan *string) {
for {
messageToSend := <-givenChan
ircMessageToSend := irc.ParseMessage(*messageToSend)
if err := s.writer.Encode(ircMessageToSend); err != nil {
log.Errorf("Error sending message %s: %s", *messageToSend, err.Error())
break
}
}
}
func (s *Scraper) StartMessages() {
log.Debug("Starting messages")
go s.refreshChannels()
ticker := time.NewTicker(TIME_BETWEEN_CHANNEL_SCRAPES)
go func() {
for {
<-ticker.C
s.refreshChannels()
log.Debug("Grabbed new channels")
log.Debugf("Now subscribed to %d channels", len(s.SubscribedTo))
}
}()
}
func (s *Scraper) refreshChannels() {
locator := NewLocator()
s.refreshBlacklist()
s.partBlacklistedChannels()
topChannels := locator.GetTopNChannels(CHANNELS_TO_GET_PER_SCRAPE)
for i := 0; i < len(topChannels); i++ {
s.clientChan <- &topChannels[i]
}
}
func (s *Scraper) partBlacklistedChannels() {
// This is disgusting
for channel := range s.blacklistedChannels {
if s.SubscribedTo[channel] {
leaveString := fmt.Sprintf(IRC_PART_STRING, channel)
s.writeChan <- &leaveString
delete(s.SubscribedTo, channel)
time.Sleep(time.Second * 2)
}
}
}
// Temporary hack to allow (manual) blacklisting of channels
func (s *Scraper) refreshBlacklist() {
// Check whether we even have a blacklist file
if _, err := os.Stat(".channelblacklist"); os.IsNotExist(err) {
// We don't have a blacklist file
log.Debug("No .channelblacklist file detected")
return
}
file, err := os.Open(".channelblacklist")
if err != nil {
log.Criticalf("Problem when opening blacklist file: %s", err.Error())
return
}
defer file.Close()
newBlacklist := make(map[string]bool)
// Read in the new blacklist
scanner := bufio.NewScanner(file)
for scanner.Scan() {
newBlacklist[scanner.Text()] = true
}
if err := scanner.Err(); err != nil {
log.Criticalf("Error whilst reading blacklist file: %s. Not swapping list",
err.Error())
return
}
// Locking probably not required - but hey, why not
// Old map should be GC'ed
s.blacklistMutex.Lock()
s.blacklistedChannels = newBlacklist
s.blacklistMutex.Unlock()
}