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
397
398
399
400
401
402
403
404
405
406
407
pub use self::bot_cmd::BotCmdAttr;
pub use self::bot_cmd::BotCmdAuthLvl;
pub use self::bot_cmd::BotCmdResult;
pub use self::bot_cmd::BotCommand;
pub use self::config::Config;
pub use self::config::IntoConfig;
pub use self::err::Error;
pub use self::err::ErrorKind;
pub use self::err::Result;
pub use self::handler::BotCmdHandler;
pub use self::handler::ErrorHandler;
pub use self::handler::TriggerHandler;
use self::irc_msgs::parse_msg_to_nick;
pub use self::irc_msgs::MsgDest;
pub use self::irc_msgs::MsgMetadata;
pub use self::irc_msgs::MsgPrefix;
use self::irc_msgs::OwningMsgPrefix;
use self::irc_send::push_to_outbox;
use self::misc_traits::GetDebugInfo;
pub use self::modl_sys::mk_module;
pub use self::modl_sys::Module;
use self::modl_sys::ModuleFeatureInfo;
use self::modl_sys::ModuleInfo;
use self::modl_sys::ModuleLoadMode;
pub use self::reaction::ErrorReaction;
use self::reaction::LibReaction;
pub use self::reaction::Reaction;
pub use self::trigger::Trigger;
pub use self::trigger::TriggerAttr;
pub use self::trigger::TriggerPriority;
use crossbeam_channel;
use irc::client::prelude as aatxe;
use irc::client::prelude::ClientExt as AatxeClientExt;
use irc::proto::Message;
use rand::EntropyRng;
use rand::SeedableRng;
use rand::StdRng;
use std::borrow::Borrow;
use std::borrow::Cow;
use std::collections::BTreeMap;
use std::path::PathBuf;
use std::sync::Arc;
use std::sync::Mutex;
use std::sync::RwLock;
use std::thread;
use uuid::Uuid;

pub(crate) mod bot_cmd;

mod config;
mod err;
mod handler;
mod irc_comm;
mod irc_msgs;
mod irc_send;
mod misc_traits;
mod modl_sys;
mod pkg_info;
mod reaction;
mod state;
mod trigger;

const THREAD_NAME_FAIL: &str = "This thread is unnamed?! We specifically gave it a name; what \
                                happened?!";

const LOCK_EARLY_POISON_FAIL: &str =
    "A lock was poisoned?! Already?! We really oughtn't have panicked yet, so let's panic some \
     more....";

pub struct State {
    aatxe_clients: RwLock<BTreeMap<ServerId, aatxe::IrcClient>>,
    addressee_suffix: Cow<'static, str>,
    commands: BTreeMap<Cow<'static, str>, BotCommand>,
    config: config::Config,
    error_handler: Arc<ErrorHandler>,
    module_data_path: PathBuf,
    modules: BTreeMap<Cow<'static, str>, Arc<Module>>,
    // TODO: This is server-specific.
    msg_prefix: RwLock<OwningMsgPrefix>,
    rng: Mutex<StdRng>,
    servers: BTreeMap<ServerId, RwLock<Server>>,
    triggers: BTreeMap<TriggerPriority, Vec<Trigger>>,
}

#[derive(Debug)]
struct Server {
    id: ServerId,
    aatxe_config: Arc<aatxe::Config>,
    socket_addr_string: String,
}

#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct ServerId {
    uuid: Uuid,
}

impl ServerId {
    fn new() -> Self {
        ServerId {
            uuid: Uuid::new_v4(),
        }
    }
}

impl State {
    fn new<ErrF>(
        config: config::Config,
        module_data_path: PathBuf,
        error_handler: ErrF,
    ) -> Result<State>
    where
        ErrF: ErrorHandler,
    {
        let msg_prefix = RwLock::new(OwningMsgPrefix::from_string(format!(
            "{}!{}@",
            config.nickname, config.username
        )));

        Ok(State {
            aatxe_clients: Default::default(),
            addressee_suffix: ": ".into(),
            commands: Default::default(),
            config: config,
            error_handler: Arc::new(error_handler),
            module_data_path,
            modules: Default::default(),
            msg_prefix,
            rng: Mutex::new(StdRng::from_rng(EntropyRng::new())?),
            servers: Default::default(),
            triggers: Default::default(),
        })
    }

    fn handle_err<S>(&self, err: Error, desc: S) -> Option<LibReaction<Message>>
    where
        S: Borrow<str>,
    {
        let desc = desc.borrow();

        let reaction = self.error_handler.run(err);

        match reaction {
            ErrorReaction::Proceed => {
                trace!(
                    "Proceeding despite error{}{}{}.",
                    if desc.is_empty() { "" } else { " (" },
                    desc,
                    if desc.is_empty() { "" } else { ")" }
                );
                None
            }
            ErrorReaction::Quit(msg) => {
                trace!(
                    "Quitting because of error{}{}{}.",
                    if desc.is_empty() { "" } else { " (" },
                    desc,
                    if desc.is_empty() { "" } else { ")" }
                );
                Some(irc_comm::mk_quit(msg))
            }
        }
    }

    fn handle_err_generic(&self, err: Error) -> Option<LibReaction<Message>> {
        self.handle_err(err, "")
    }
}

pub fn run<Cfg, ModlData, ErrF, ModlCtor, Modls>(
    config: Cfg,
    module_data_path: ModlData,
    error_handler: ErrF,
    modules: Modls,
) where
    Cfg: IntoConfig,
    ModlData: Into<PathBuf>,
    ErrF: ErrorHandler,
    Modls: IntoIterator<Item = ModlCtor>,
    ModlCtor: Fn() -> Module,
{
    let config = match config.into_config() {
        Ok(cfg) => {
            trace!("Loaded configuration: {:#?}", cfg);
            cfg
        }
        Err(e) => {
            error_handler.run(e);
            error!("Terminal error: Failed to load configuration.");
            return;
        }
    };

    let mut state = match State::new(config, module_data_path.into(), error_handler) {
        Ok(s) => {
            trace!("Assembled bot state.");
            s
        }
        Err(e) => {
            error!("Terminal error while assembling bot state: {}", e);
            return;
        }
    };

    match state.load_modules(modules.into_iter().map(|f| f()), ModuleLoadMode::Add) {
        Ok(()) => trace!("Loaded all requested modules without error."),
        Err(errs) => for err in errs {
            match state.error_handler.run(err) {
                ErrorReaction::Proceed => {}
                ErrorReaction::Quit(msg) => {
                    error!(
                        "Terminal error while loading modules: {:?}",
                        msg.unwrap_or_default().as_ref()
                    );
                    return;
                }
            }
        },
    }

    info!(
        "Loaded modules: {:?}",
        state.modules.keys().collect::<Vec<_>>()
    );
    info!(
        "Loaded commands: {:?}",
        state.commands.keys().collect::<Vec<_>>()
    );

    let mut servers = BTreeMap::new();

    for aatxe_config in &state.config.servers {
        let server_id = ServerId::new();

        let socket_addr_string = match (&aatxe_config.server, aatxe_config.port) {
            (Some(h), Some(p)) => format!("{}:{}", h, p),
            (Some(h), None) => format!("{}:<unknown port>", h),
            (None, Some(p)) => format!("<unknown hostname>:{}", p),
            (None, None) => format!("<unknown hostname>:<unknown port>"),
        };

        let server = Server {
            id: server_id,
            aatxe_config: aatxe_config.clone(),
            socket_addr_string,
        };

        match servers.insert(server_id, RwLock::new(server)) {
            None => {}
            Some(other_server) => {
                error!(
                    "This shouldn't happen, but there was already a server registered with UUID \
                     {uuid}: {other_server:?}",
                    uuid = server_id.uuid.hyphenated(),
                    other_server = other_server.read().expect(LOCK_EARLY_POISON_FAIL),
                );
                return;
            }
        }
    }

    state.servers = servers;

    let state = Arc::new(state);
    trace!("Stored bot state onto heap.");

    let mut aatxe_reactor = match aatxe::IrcReactor::new() {
        Ok(r) => {
            trace!("Successfully initialized IRC reactor.");
            r
        }
        Err(e) => {
            error!("Terminal error: Failed to initialize IRC reactor: {}", e);
            return;
        }
    };

    let (outbox_sender, outbox_receiver) = crossbeam_channel::bounded(irc_send::OUTBOX_SIZE);

    spawn_thread(
        &state,
        "*".into(),
        "send",
        |_| "sending thread".into(),
        |state| irc_send::send_main(state, outbox_receiver),
    );

    for (&server_id, server) in &state.servers {
        let server = server.read().expect(LOCK_EARLY_POISON_FAIL);

        let state_alias = state.clone();

        let outbox_sender_clone = outbox_sender.clone();

        let aatxe_client = match aatxe_reactor.prepare_client_and_connect(&server.aatxe_config) {
            Ok(client) => {
                trace!("Connected to server {:?}.", server.socket_addr_string);
                client
            }
            Err(err) => {
                error!(
                    "Failed to connect to server {:?}: {}",
                    server.socket_addr_string, err,
                );
                continue;
            }
        };

        match state
            .aatxe_clients
            .write()
            .expect(LOCK_EARLY_POISON_FAIL)
            .insert(server_id, aatxe_client.clone())
        {
            None => {}
            Some(_other_aatxe_client) => {
                // TODO: If <https://github.com/aatxe/irc/issues/104> is resolved in favor of
                // `IrcServer` implementing `Debug`, add the other server to this message.
                error!(
                    "This shouldn't happen, but there was already a server registered \
                     with UUID {uuid}!",
                    uuid = server_id.uuid.hyphenated(),
                );
                return;
            }
        }

        match aatxe_client.identify() {
            Ok(()) => debug!(
                "recv[{}]: Sent identification sequence to server.",
                server.socket_addr_string
            ),
            Err(e) => error!(
                "recv[{}]: Failed to send identification sequence to server: {}",
                server.socket_addr_string, e
            ),
        }

        aatxe_reactor.register_client_with_handler(aatxe_client, move |_aatxe_client, msg| {
            handle_msg(&state_alias, server_id, &outbox_sender_clone, Ok(msg));

            Ok(())
        });
    }

    match aatxe_reactor.run() {
        Ok(()) => trace!("IRC reactor shut down normally."),
        Err(e) => error!("IRC reactor shut down abnormally: {}", e),
    }
}

fn handle_msg(
    state: &Arc<State>,
    server_id: ServerId,
    outbox: &irc_send::OutboxPort,
    input: Result<Message>,
) {
    match input.and_then(|msg| irc_comm::handle_msg(&state, server_id, outbox, msg)) {
        Ok(()) => {}
        Err(e) => push_to_outbox(outbox, server_id, state.handle_err_generic(e)),
    }
}

fn spawn_thread<F, PurposeF>(
    state: &Arc<State>,
    addr: String,
    purpose_desc_abbr: &str,
    purpose_desc_full: PurposeF,
    business: F,
) where
    F: FnOnce(Arc<State>) -> Result<()> + Send + 'static,
    PurposeF: FnOnce(&str) -> String,
{
    let label = format!("{}[{}]", purpose_desc_abbr, addr);

    let state_alias = state.clone();

    let thread_build_result = thread::Builder::new().name(label).spawn(move || {
        let current_thread = thread::current();
        let thread_label = current_thread.name().expect(THREAD_NAME_FAIL);

        trace!("{}: Starting....", thread_label);

        match business(state_alias) {
            Ok(()) => debug!("{}: Thread exited successfully.", thread_label),

            // TODO: Call `state.error_handler`.
            Err(err) => error!("{}: Thread exited with error: {:?}", thread_label, err),
        }
    });

    match thread_build_result {
        Ok(thread::JoinHandle { .. }) => {
            trace!("Spawned {purpose}.", purpose = purpose_desc_full(&addr));
        }
        Err(err) => match state.error_handler.run(err.into()) {
            ErrorReaction::Proceed => error!(
                "Failed to create {purpose}; ignoring.",
                purpose = purpose_desc_full(&addr),
            ),
            ErrorReaction::Quit(msg) => error!(
                "Terminal error: Failed to create {purpose}: {msg:?}",
                purpose = purpose_desc_full(&addr),
                msg = msg
            ),
        },
    }
}