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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
use std::collections::HashSet;
use std::io::{BufRead, BufReader, Read, Write};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;

use super::{Capability, Error, LocalUser, Message, UserConfig, Writer};
use crate::filter::{Filter, MessageFilter};

// TODO handle shutdowns better

/// Client for interacting with Twitch's chat.
pub struct Client<R> {
    reader: BufReader<R>,
    writer: Writer,
    handle: std::thread::JoinHandle<()>,
    filters: HashSet<Filter>,

    desired_name: String,
    caps: Vec<Capability>,
    has_error: bool,

    ready_state: Option<ReadyState>,
    state: ClientState,

    want_tags: bool,
    irc_ready: bool,

    quit: Arc<AtomicBool>,
}

impl<R> Client<R>
where
    R: Read + Sync + Send,
{
    /// Creates and registers a new Client with the IRC server.
    ///
    /// Takes a [`UserConfig`](./struct.UserConfig.html) and a [`Read`](https://doc.rust-lang.org/std/io/trait.Read.html)/[`Write`](https://doc.rust-lang.org/std/io/trait.Write.html) pair
    ///
    /// Returns the Client, or an error if it cannot write to the `W`
    pub fn register<U, W>(config: U, read: R, write: W) -> Result<Self, Error>
    where
        U: std::borrow::Borrow<UserConfig>,
        W: Write + Sync + Send + 'static,
    {
        let quit = Arc::new(AtomicBool::new(false));
        let (writer, rx) = Writer::new(Arc::clone(&quit));

        let config = config.borrow();
        // check for anonymous login ('justinfan1234')
        let is_anonymous = config.nick == super::userconfig::JUSTINFAN1234
            && config.token == super::userconfig::JUSTINFAN1234;

        let want_tags = config.caps.contains(&Capability::Tags) && !is_anonymous;
        for cap in config.caps.iter().filter_map(|c| c.get_command()) {
            writer.write_line(cap)?;
        }

        log::trace!("registering");
        writer.write_line(format!("PASS {}", config.token))?;
        writer.write_line(format!("NICK {}", config.nick))?;
        log::trace!("registered");

        let handle = std::thread::spawn(move || {
            log::trace!("starting write loop");
            let mut w = write;
            for msg in rx {
                if w.write_all(msg.as_bytes()).is_err() {
                    break;
                }
            }
            log::trace!("ending write loop");
        });

        Ok(Self {
            reader: BufReader::new(read),
            writer,
            handle,
            filters: HashSet::new(),

            desired_name: config.nick.to_string(),
            caps: vec![],
            has_error: false,

            ready_state: None,
            state: ClientState::Start,

            want_tags,
            irc_ready: is_anonymous,

            quit,
        })
    }

    /// Add this filter to the iterator
    ///
    /// When this type of `command` is received, it'll be *produced* by the `Client Iterator` as a [`Event::Message`](./enum.Event.html#variant.Message)
    ///
    /// A MessageFilter is basically a magic type that represents a [`Command`](./commands/index.html)
    ///
    /// To use this simply:
    /// ```ignore
    /// use twitchchat::commands::*;
    /// // client is created by Client::register()
    /// client.filter::<PrivMsg>() // add a PrivMsg
    ///       .filter::<Join>() // add a Join
    /// // and so forth
    /// ```
    /// The 'Command' type is used as a turbofish argument    
    pub fn filter<F: MessageFilter>(mut self) -> Self {
        let filter = F::to_filter();
        log::trace!("adding filter: {:?}", filter);
        let _ = self.filters.insert(filter);
        self
    }

    /// Remove this filter
    ///    
    /// Returns whether this fitler was present
    ///
    /// **note** This type isn't chainable
    ///
    /// ```ignore
    /// let client client.filter::<PrivMsg>();
    /// assert!(client.remove_filter::<PrivMsg>());
    /// assert!(!client.remove_filter::<PrivMsg());
    /// ```
    pub fn remove_filter<F: MessageFilter>(&mut self) -> bool {
        let filter = F::to_filter();
        log::trace!("removing filter: {:?}", filter);
        self.filters.remove(&filter)
    }

    /// Sets the iterator to start when we've received the 'ok' from the irc server
    ///
    /// When this event happens, a [`Event::IrcReady`](enum.Event.html#variant.IrcReady) is produced by the iterator
    ///
    /// - If the `tags` capability was not set, then this is automatically set.
    /// - If this is not set and the `tags` capability was set, then a [`Event::TwitchReady`](enum.Event.html#variant.TwitchReady) is produced instead
    ///
    /// It will try to be smart and produce a `TwitchReady` event if desired, otherwise `IrcReady` was produced
    pub fn when_irc_ready(mut self) -> Self {
        self.irc_ready = true;
        self
    }

    /// Get a clonable writer from the client
    pub fn writer(&self) -> Writer {
        log::trace!("cloning writer");
        self.writer.clone()
    }

    /// This is useful to synchronize the closing of the 'Read'
    pub fn wait_for_close(self) {
        log::trace!("waiting for thread to join");
        let _ = self.handle.join();
        log::trace!("thread joined");
    }

    fn read_message(&mut self) -> Result<Option<Message>, Error> {
        if self.quit.load(Ordering::SeqCst) {
            log::trace!("quitting");
            return Ok(None);
        }

        let mut line = String::new(); // reuse this
        if self.reader.read_line(&mut line).map_err(|err| {
            log::warn!("failed to read: {}", err);
            Error::CannotRead
        })? == 0
        {
            log::warn!("cannot read (amount was empty)");
            return Err(Error::CannotRead);
        }

        if self.quit.load(Ordering::SeqCst) {
            log::trace!("quitting");
            return Ok(None);
        }

        let _ = line.remove(line.len() - 1);
        assert!(!line.is_empty(), "line should not be just a '\r'");
        log::trace!("<- {}", line);
        let msg = crate::irc::Message::parse(&line).ok_or_else(|| Error::InvalidMessage(line))?;;

        match &msg {
            crate::irc::Message::Unknown {
                prefix,
                head,
                args,
                tail,
                ..
            } => {
                if let (Some(crate::irc::Prefix::Server { host }), Some(data)) = (prefix, tail) {
                    if head == "NOTICE"
                        && host == "tmi.twitch.tv"
                        && data == "Improperly formatted auth"
                        && args.get(0).map(|k| k.as_str()) == Some("*")
                    {
                        log::warn!("got a registration error");
                        return Err(Error::InvalidRegistration);
                    }
                }
                Ok(Some(Message::parse(msg)))
            }
            crate::irc::Message::Ping { token } => {
                self.writer.write_line(format!("PONG :{}", token))?;
                Ok(Some(Message::Irc(Box::new(msg))))
            }
            _ => Ok(Some(Message::Irc(Box::new(msg)))),
        }
    }
}

/// An event received while reading from the client
#[derive(Debug)]
pub enum Event {
    /// An IRC ready event was requested, returning the your IRC name
    IrcReady(String),
    /// A twitch ready event was requested, returning your twitch user
    TwitchReady(LocalUser),
    /// A twitch message
    Message(Message),
    /// An error
    Error(Error),
}

// TODO this could be a lot simpler
impl<R> Iterator for Client<R>
where
    R: Read + Sync + Send,
{
    type Item = Event;

    fn next(&mut self) -> Option<Self::Item> {
        if self.quit.load(Ordering::SeqCst) {
            log::trace!("quitting");
            return None;
        }

        if self.has_error {
            return None;
        }

        macro_rules! error {
            ($err:expr) => {{
                self.has_error = true;
                return Some(Event::Error($err));
            }};
        }

        macro_rules! read {
            () => {
                match self.read_message() {
                    Ok(Some(msg)) => {
                        if self.quit.load(Ordering::SeqCst) {
                            log::trace!("quitting");
                            return None;
                        }
                        msg
                    }
                    Ok(None) => return None,
                    Err(err) => error!(err),
                }
            };
        }

        if self.ready_state.is_none() {
            let _ = self
                .ready_state
                .replace(match (self.irc_ready, self.want_tags) {
                    (true, false) | (false, false) | (true, true) => ReadyState::Irc,
                    (false, true) => ReadyState::Twitch,
                });
        }
        let ready = self.ready_state.unwrap();

        match self.state {
            ClientState::Start => {
                log::trace!("state is: {:?}", self.state);
                let msg = read!();
                match &msg {
                    Message::Irc(msg) => match &**msg {
                        crate::irc::Message::Cap {
                            acknowledge: true,
                            cap,
                        } => match cap.as_str() {
                            "twitch.tv/tags" => self.caps.push(Capability::Tags),
                            "twitch.tv/membership" => self.caps.push(Capability::Membership),
                            "twitch.tv/commands" => self.caps.push(Capability::Commands),
                            _ => {}
                        },
                        _ => {}
                    },
                    _ => {}
                };

                self.state.next(ready);
                return Some(Event::Message(msg));
            }
            ClientState::IrcReady => loop {
                log::trace!("state is: {:?}", self.state);
                match read!() {
                    Message::Irc(msg) => {
                        if let crate::irc::Message::Ready { name } = *msg {
                            self.state.next(ready);
                            return Some(Event::IrcReady(name));
                        }
                    }
                    _ => continue,
                }
            },
            ClientState::TwitchReady => loop {
                log::trace!("state is: {:?}", &self.state);
                match read!() {
                    Message::Irc(msg) => match *msg {
                        crate::irc::Message::Cap {
                            acknowledge: true,
                            cap,
                        } => match cap.as_str() {
                            "twitch.tv/tags" => self.caps.push(Capability::Tags),
                            "twitch.tv/membership" => self.caps.push(Capability::Membership),
                            "twitch.tv/commands" => self.caps.push(Capability::Commands),
                            _ => {}
                        },
                        crate::irc::Message::Ready { .. } => {
                            let mut bad = vec![];
                            match (
                                self.caps.contains(&Capability::Tags),
                                self.caps.contains(&Capability::Commands),
                            ) {
                                (true, true) => continue,
                                (false, true) => bad.push(Capability::Tags),
                                (true, false) => bad.push(Capability::Commands),
                                _ => {
                                    bad.push(Capability::Tags);
                                    bad.push(Capability::Commands);
                                }
                            };
                            if !bad.is_empty() {
                                error!(Error::CapabilityRequired(bad))
                            }
                        }
                        _ => {}
                    },
                    Message::GlobalUserState(state) => {
                        self.state.next(ready);
                        return Some(Event::TwitchReady(LocalUser {
                            user_id: state.user_id(),
                            display_name: state.display_name().map(ToString::to_string),
                            name: self.desired_name.clone(),
                            color: state.color(),
                            badges: state.badges(),
                            emote_sets: state.emote_sets(),
                            caps: self.caps.clone(),
                        }));
                    }
                    _ => continue,
                }
            },
            ClientState::Go => loop {
                let msg = read!();
                let filter = msg.what_filter();
                if self.filters.contains(&filter) {
                    log::debug!("dispatching to a : {:?}", filter);
                    return Some(Event::Message(msg));
                }
            },
        }
    }
}

#[derive(Debug, Copy, Clone, PartialEq)]
enum ReadyState {
    Irc,
    Twitch,
}

#[derive(Debug, Copy, Clone, PartialEq)]
enum ClientState {
    Start = 0,
    IrcReady = 1,
    TwitchReady = 2,
    Go = 3,
}

impl ClientState {
    fn next(&mut self, ready: ReadyState) {
        let _ = match self {
            ClientState::Start if ready == ReadyState::Irc => {
                std::mem::replace(self, ClientState::IrcReady)
            }
            ClientState::Start => std::mem::replace(self, ClientState::TwitchReady),
            _ => std::mem::replace(self, ClientState::Go),
        };
    }
}